Tech-invite  3GPPspace  IETFspace
◀  ▶  21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x

Content for  TS 27.007  Word version:  19.4.0

Top   Top   Up   Prev   Next
1…   4…   5…   6…   6.10…   6.20…   7…   7.10…   7.20…   7.30…   7.40…   8…   8.10…   8.20…   8.30…   8.40…   8.50…   8.55   8.56…   8.60…   8.70…   8.80…   9…   10…   10.1.3…   10.1.10…   10.1.20…   10.1.30…   10.1.40…   10.1.50…   10.1.60…   10.1.70…   10.1.80…   10.2…   11…   12…   13…   14…   15…   16…   17…   18…   19…   20…   A   B   C…   E   F   G… 
20 Commands for eUICC profile activation  20.1 General  20.2 Commands specific to eUICC profile activation  20.2.1 eUICC profile download +CEUICCPD  20.2.2 eUICC profile management +CEUICCPM  20.2.3 eUICC profile metadata information +CEUICCPMETAI  20.2.4 eUICC memory reset +CEUICCMEMRESET  20.2.5 eUICC update default SM-DP+ address +CEUICCUSMDPA  20.2.6 Get eUICC ID +CGEUICCID  20.2.7 eUICC profile notification management +CEUICCPNM  20.2.8  Log SIM APDU +CLOGSIMAPDU  20.2.9  Log and Buffer SIM APDU +CLOGBUFFSIMAPDU 
...

 

20  Commands for eUICC profile activation |R19|  p. 451

20.1  General  p. 451

The Generic Test Profile as specified in GSMA TS.48 [195] has been developed to fulfil requirements for execution of device tests. The test profile can have more than one configuration based on testing requirements and these can be loaded onto an eUICC for different test scenarios. One or more than one profile can be enabled on the same embedded UICC (eUICC) as specified in GSMA SGP.21 [193]. This clause defines AT commands for managing multiple profiles on an eUICC as specified in GSMA SGP.22 [194]. Several of the parameters and procedures defined in GSMA SGP.22 [194] are referenced in these AT commands.
A set of eUICC profile management commands is defined for provisioning, activating, managing multiple profiles, and providing the flexibility to users to be able to switch between them as needed. The commands use the extended information and error message capabilities described in the present specification.
The +CEUICCPD command is used to invoke the LPA (Local Profile Assistant) to trigger a request to download and install a profile in an eUICC through activation code procedure as specified in GSMA SGP.22 [194]. The +CEUICCPM command is used to enable, disable, or delete a profile in an eUICC. The +CEUICCPMETAI command allows the user to assign a nickname to a profile and to read and display the profile metadata information for all profiles installed in the eUICC irrespective of the state of the profile. The +CEUICCMEMRESET command triggers the eUICC capable UE to request the LPA to perform eUICC memory reset including its associated profile metadata. The +CEUICCSMDPA command allows the user to edit a default SM-DP+ address on the eUICC. The +CGEUICCID command requests the eUICC identifier from the eUICC in the device. The +CEUICCPNM command is used to manage the pending notifications that are generated when a profile management operation has been successfully performed on the eUICC.
Up

20.2  Commands specific to eUICC profile activation  p. 452

20.2.1  eUICC profile download +CEUICCPD  p. 452

Command Possible response(s)
+CEUICCPD=<mode>,<matching_ID>/ <confirmation_code>[,<smdp_address>]+CME ERROR: <err>
+CEUICCPD=?+CEUICCPD: (list of supported <requested_unper_duration>s)
Description
The set command is used to invoke the LPA (present in eUICC or the device) to trigger a request to download and install a profile in the eUICC through the activation code procedure from the SM-DP+ address. Unless explicitly provided in this command, the default SM-DP+ address if already present in the device or eUICC shall be used.
The command returns with the response depending upon whether the request is successfully sent to LPA or not. The actual result for the download and installation will be displayed through the one time unsolicited result code +CEUICCPDU: <result>[,[<iccid>] [,<cause_source>[,<cause>]]] once the activation code procedure ends.
Optionally, if the activation code token indicates that a confirmation code is also required, the user is prompted through +CEUICCPDU to input a confirmation code provided to them by the issuing MSP. The set command can be used to respond with the confirmation code.
Test command returns supported values as a compound value.
Defined values
<mode>
integer type;
0
send activation code.
1
send confirmation code.
<confirmation_code>
string type; indicates the confirmation code that is to be used to download and install the profile from SM-DP+. This shall be procured from the MSP (Mobile Service Provider) while subscribing through external means. If <mode> = 1, <confirmation_code> needs to be provided.
<matching_ID>
string type; indicates the matching ID that is to be used to download and install the profile from SM-DP+. If <mode> = 0, <matching_ID> needs to be provided.
<smdp_address>
string type; indicates the address for SM-DP+. This shall be used by LPA to identify the SM-DP+ where the profile is stored and available for download.
<result>
integer type; indicates the final result for downloading and installing a profile.
0
Successfully downloaded and installed.
1
Failed to download and install.
2
Confirmation code required.
3
Successfully downloaded but PIN locked. Refer +CPIN to unlock.
<iccid>
string type; indicates a unique number to identify a Profile in an eUICC.
<cause_source>
integer type; indicates the function returning the error cause while the procedure for download and install is being executed for a profile. These functions are associated to a particular eUICC interface, for example ES9+ is used to provide a secure transport between the SM-DP+ and the LPA for the delivery of the profile package and ES10b is used by the LPA to transfer a profile package to the eUICC. <cause_source> will be present when <result>=1 as specified in GSMA SGP.22 [194].
0
Unknown
1
Generic error for ES10b interface.
2
Function performs the authentication of the RSP Server by the eUICC (AuthenticateServer, ES10b)
3
Function initiates a Bound Profile Package download after a successful authentication of an SM-DP+ ( PrepareDownload, ES10b).
4
Function transfers a Bound Profile Package to the eUICC (LoadBoundProfilePackage, ES10b)
5
Function requests the SM-DP+ authentication (InitiateAuthentication, ES9+)
6
Function called by the LPA to request the authentication of the eUICC by the SM-DP+ (AuthenticateClient, ES9+)
7
Function called to request the delivery and the binding of a profile package for the eUICC (GetBoundProfilePackage, ES9+)
8
Generic error for ES9+ interface
<cause>
integer type, indicating the error cause because of which the procedure of downloading and installing a profile has been terminated. <cause> will be present when <result>=1 as specified in GSMA SGP.22 [194].
Implementation
Optional.
Up

20.2.2  eUICC profile management +CEUICCPM  p. 453

Command Possible response(s)
+CEUICCPM=<operation>,<iccid>+CME ERROR: <err>
+CEUICCPM?[+CEUICCPM: <iccid1>,<state>[,<iccid2>,<state>]
+CEUICCPM=?+CEUICCPM: (range of supported <iccid>s),(list of supported <operation>s)
Description
The set command is used to enable, disable or delete a profile in an eUICC. This is applicable for an eUICC capable device having profile(s) installed in the eUICC. For devices supporting two simultaneous device cellular connections, simultaneously two profiles may be enabled. To delete a profile, the profile must be disabled. The command returns with the response depending upon whether the request is successfully sent to LPA or not.
The actual result for the operations will be displayed through the one time unsolicited result code +CEUICCPMU: <result>[,[<iccid>],[<state>][,<cause>]]] once the procedure ends. Refer to clause 9.2 for possible <err> values.
Read command returns the current settings for each installed profile.
Test command returns the list of <iccid>s indicating the list of profiles installed and the list of <operation>s that shall be triggered.
Defined values
<operation>
integer type, indicates the operation to be done for the management of the profiles installed in the eUICC.
0
disable profile
1
enable profile
2
delete profile
<iccid>
string type; indicates a unique number to identify a profile in an eUICC.
<state>
integer type, indicates the current state of the profile.
0
disabled
1
enabled
2
deleted
<result>
integer type; indicates the final result for the action triggered by the user.
0
Successfully enabled, disabled, or deleted a profile.
1
Failed to complete enabling, disabling, or deleting a profile.
<cause>
integer type, indicating the error cause because of which the procedure of enabling, disabling, or deleting a profile has been terminated. <cause> will be present when <result>=1 as specified in GSMA SGP.22 [194].
0
unknown
1
ICCID (Integrated Circuit Card ID) or AID (Application Identifier) not found
2
profile not in disabled state
3
profile not in enabled state
4
disallowed by policy
5
wrong profile re-enabling
6
busy (proactive session ongoing on the target port)
Implementation
Optional.
Up

20.2.3  eUICC profile metadata information +CEUICCPMETAI  p. 455

Command Possible response(s)
+CEUICCPMETAI=<operation>[,<iccid>[,<nickname>]]+CEUICCPMETAI: <iccid>,<state>,profile_metadata>
[<CR><LF>+CEUICCPMETAI: <iccid>,<state>,profile_metadata> […]]]
+CME ERROR: <err>
+CEUICCPMETAI=?+CEUICCPMETAI: (list of supported <operation>s)
Description
The set command allows the user to read and display the profile metadata information for all the profiles installed in the eUICC irrespective of the state of the profile. The command also allows the user to attribute a nickname to a profile for ease of use. Adding or changing a nickname shall not affect any other data or other profile metadata for that profile.
Test command returns the list of <operation>s that shall be triggered.
Defined values
<operation>
integer type, indicates the operation to be done for the management of the profiles installed in the eUICC.
0
Read the profile metadata for all the profiles(default)
1
Read the profile metadata for the profile identified by <iccid>. In this case, <iccid> needs to be provided.
2
Add/Update the nickname for a particular profile in the profile metadata. In this case, <iccid> and <nickname> needs to be provided.
<iccid>
string type; indicates a unique number to identify a profile in an eUICC.
<state>
integer type, indicates the current state of the profile.
0
disabled
1
enabled
<profile_metadata>
string type, indicates the profile metadata information for a profile. This shall include the following information; MSP name, ICCID, user nickname of the profile, short description of the profile defined by the operator or MSP. The list of information that this command shall display is implementation specific.
Implementation
Optional.
Up

20.2.4  eUICC memory reset +CEUICCMEMRESET  p. 455

Command Possible response(s)
+CEUICCMEMRESET+CME ERROR: <err>
+CEUICCMEMRESET=?
Description
The set command triggers the eUICC capable UE to request the LPA to perform eUICC memory reset including its associated profile metadata. This requires the verification of the user's intent for which the notification from LPA to user is triggered and then the user is prompted to respond to the same. Refer command +CEUICCUIV. The command returns with the response depending upon whether the request is successfully sent to LPA or not. The actual result for the memory reset will be displayed through the unsolicited result code +CEUICCMEMRESETU: <result>[,<cause>] once the procedure ends.
Defined values
<result>: integer type; indicates the final result for the eUICC memory reset.
0
Successfully reset the eUICC memory
1
Failed to reset the eUICC memory.
<cause>
integer type, indicating the error cause because of which the procedure to reset an eUICC has been terminated. <cause> will be present when <result>=1 as specified in GSMA SGP.22 [194].
0
unknown
1
nothing to delete
2
busy
Implementation
Optional.
Up

20.2.5  eUICC update default SM-DP+ address +CEUICCUSMDPA  p. 456

Command Possible response(s)
+CEUICCUSMDPA=<smdp_address>+CME ERROR: <err>
+CEUICCUSMDPA=?
Description
The set command allows the user to edit a default SM-DP+ address on the eUICC or device. The command returns with the response depending upon whether the request is successfully sent to LPA or not. The actual result for updating the SM-DP+ address will be displayed through the one time unsolicited result code +CEUICCUSMDPAU: <result> once the procedure ends.
Defined values
<smdp_address>
string type; indicates the SM-DP+ address which will replace he default SM-DP+ address in the eUICC or device.
<result>
integer type; indicates the final result for updating the default SM-DP+ address.
0
Successfully updated the SM-DP+ address
1
Failed to update the SM-DP+ address.
Implementation
Optional.
Up

20.2.6  Get eUICC ID +CGEUICCID  p. 457

Command Possible response(s)
+CGEUICCID+CGEUICCID: <EID>
+CGEUICCID=?
Description
The set command triggers the eUICC capable UE to request the eUICC ID <EID> from the eUICC present in the device. This command can be used at any time by the user to get the <EID> through LPA.
Defined values
<EID>
string type; indicates the eUICC identifier which is composed of 32 digits where each digit is represented by one character in the set [0123456789]. Examples of valid <EID>s are: 
8900 1012 0123 4123 4012 3456 7890 1224
8900 1567 0102 0304 0506 0708 0910 1152
8904 4011 1122 3344 1122 3344 1122 3321
0090 9231 2229 9992 3581 2903 6544 3008
Implementation
Optional.
Up

20.2.7  eUICC profile notification management +CEUICCPNM  p. 457

Command Possible response(s)
+CEUICCPNM=<operation>[,<seq_no>]In case <operation>=0 [+CEUICCPNM: <seq_no>,<profile_event>[,<iccid>] [<CR><LF>+CEUICCPNM: <seq_no2>,<profile_event>[,<iccid>] […]]]
+CME ERROR: <err>
+CEUICCPNM=?+CEUICCPM: (list of supported <operation>s)
Description
The set command is used to manage the pending notifications that are generated when a profile management operation has been successfully performed on the eUICC or when there is a progress of such an operation. When <operation>=0, the command returns the list of sequence numbers where each sequence number represents a pending notification. When <operation>=1, the command triggers the LPA to send all the pending notifications to SM-DP+. When <operation>=2, the command triggers the LPA to delete a particular pending information using the sequence number that was fetched through <operation>=0.
Test command returns the the list of <operation>s that shall be triggered.
Defined values
<operation>
integer type, indicates the operation to be done for the notification management of the profiles installed in the eUICC.
0
List pending notification
1
Send all pending notifications to SM-DP+
2
Delete notification
<iccid>
string type; indicates a unique number to identify a profile in an eUICC.
<seq_no>
integer type, indicates the sequence number which represents a pending notification.
<profile_event>
integer type, indicates the profile event which is a notification generated by eUICC.
0
Notification on install
1
Notification on local enable
2
Notification on local disable
3
Notification on local delete
4
Notification on remote profile management enable
5
Notification on remote profile management disable
6
Notification on remote profile management delete
Implementation
Optional.
Up

20.2.8  Log SIM APDU +CLOGSIMAPDU  p. 458

Command Possible response(s)
+CLOGSIMAPDU=<n>+CME ERROR: <err>
+CLOGSIMAPDU?+CLOGSIMAPDU: <n>
+CLOGSIMAPDU=?+CLOGSIMAPDU: (list of supported <n>s)
Description
The set command controls the presentation of an unsolicited result code +CLOGSIMAPDUTD: <command_data> and +CLOGSIMAPDURD: <response_data> as an indication of a device to non-removable USIM (nrUSIM, as defined in TS 31.127) Application Protocol Data Unit (APDU) transfer or response relating to the functionality of the MT.
In case of <command_data> the syntax is as follows:
+CLOGSIMAPDUTD: SIM SLOT:<card_slot>[,LSI:<LSI>],TX Data APDU: <payload><CR><LF>
In case of <response_data> the syntax is as follows:
+CLOGSIMAPDURD: SIM SLOT:<card_slot>[,LSI:<LSI>],RX Data APDU: <payload><CR><LF>
Read command returns the current value of <n>.
Test command returns the values supported as a compound value.
Refer to clause 9.2 for possible <err> values.
Example Response:
+CLOGSIMAPDUTD: SIM SLOT:1,LSI:2,TX Data APDU: 00A4080406 // means P1:Select by path from MF P2:Need FCP return
+CLOGSIMAPDURD: SIM SLOT:1,LSI:2,RX Data APDU: A4 // means <SELECT FILE>
+CLOGSIMAPDUTD: SIM SLOT:1,LSI:2,TX Data APDU: 7FFF5FC04F0A
+CLOGSIMAPDURD: SIM SLOT:1,LSI:2,RX Data APDU: 6119
+CLOGSIMAPDUTD: SIM SLOT:1,LSI:2,TX Data APDU: 80F2000C0000
+CLOGSIMAPDURD: SIM SLOT:1,LSI:2,RX Data APDU: 9000
Defined values
<n>
integer type.
0
disable unsolicited result code +CLOGSIMAPDUTD: <command_data> and +CLOGSIMAPDURD: <response_data>
1
enable unsolicited result code +CLOGSIMAPDUTD: <command_data> and +CLOGSIMAPDURD: <response_data>
<card_slot>
integer type, indicates the physical card slot on which the data is received. Refer +CSUS in subclause 8.66.
<LSI>
integer type, indicates the logical secure element interface as defined in ETSI TS 102 221.
<payload>
hexadecimal string format, indicates the data field part of the command or response APDU data exchanged between the nrUSIM and the MT.
Implementation
Optional
Up

20.2.9  Log and Buffer SIM APDU +CLOGBUFFSIMAPDU  p. 460

Command Possible response(s)
+CLOGBUFFSIMAPDU=<card_slot>,<n>[,<filter_type>[,<no_of_ins>,<ins1><ins2>…]][+CLOGBUFFSIMAPDUTD: [SIM_SLOT:<card_slot>][<CR><LF>TX Data APDU: [<payload>]]
[<CR><LF>+CLOGBUFFSIMAPDURD: [SIM_SLOT:<card_slot>][<CR><LA>RX Data APDU: [<payload>]]
[<CR><LF>+CLOGBUFFSIMAPDUTD: [SIM_SLOT:<card_slot>][<CR><LA>TX Data APDU: [<payload>]]
[<CR><LF>+CLOGBUFFSIMAPDURD: [,SIM_SLOT:<card_slot>][<CR><LA>RX Data APDU: [<payload>]]...]]]]
OK
or
+CME ERROR: <err>
+CLOGBUFFSIMAPDU?+CLOGBUFFSIMAPDU: <card_slot1>,<n>,[,<filter_type>[,<no_of_ins>,<ins1><ins2>…]]
[<CR><LF>+CLOGBUFFSIMAPDU: <card_slot2>,<n>[,<filter_type>[,<no_of_ins>,<ins1><ins2>…]]
[…]]
+CLOGBUFFSIMAPDU=?+CLOGBUFFSIMAPDU: (list of supported <card_slot>s), (list of supported <n>s), list of supported <filter_type>s)
Description
The set command allows to buffer the array of SIM APDUs that indicates the nrUSIM command APDUs or response APDUs relating to the functionality of the MT and display the array of SIM APDUs when required.
The command displays the array of intermediate result code +CLOGBUFFSIMAPDUTD: <command_data> for command and +CLOGBUFFSIMAPDURD: <response_data> for response respectively. If no APDU has been sent or received to nrUSIM while buffering the data, only the final response OK shall be sent.
In case of <command_data> the syntax is as follows:
+CLOGBUFFSIMAPDUTD: SIM SLOT:<card_slot>[,LSI:<LSI>],TX Data APDU: <payload><CR><LF>
In case of <response_data> the syntax is as follows:
+CLOGBUFFSIMAPDURD: SIM SLOT:<card_slot>[,LSI:<LSI>],RX Data APDU: <payload><CR><LF>
Apart from enabling logging of all the SIM APDUs, optional parameter <filter_type> can be used to filter and log required SIM APDUs.
Read command returns the current values that have been set.
Test command returns the values supported as a compound value.
Refer clause 9.2 for possible <err> values.
Example Response:
AT+CLOGBUFFSIMAPDU=1,1 //start logging and buffering
OK
//APDU logging data buffered
AT+CLOGBUFFSIMAPDU=1,2 //flush buffered data
+CLOGBUFFSIMAPDUTD: SIM SLOT:1,LSI:2,TX Data APDU: 80F2000C0000
+CLOGBUFFSIMAPDURD: SIM SLOT:1,LSI:2,RX Data APDU: 9000
OK
AT+CLOGBUFFSIMAPDU=1,0 //flush and stop logging data
+CLOGBUFFSIMAPDUTD: SIM SLOT:1,LSI:2,TX Data APDU: 7FFF5FC04F0A
+CLOGBUFFSIMAPDURD: SIM SLOT:1,LSI:2,RX Data APDU: 6119
OK
Defined values
Defined values
<n>
integer type.
0
stop buffering the data, display the buffered data and flush.
1
start buffering the data +CLOGSIMAPDUTD: <command_data> and +CLOGSIMAPDURD: <response_data>. This buffering of data shall also be filtered if filtering has been enabled.
2
display the buffered data and flush. The amount of data buffered shall be implementation specific depending on the manufacturer. The displayed data shall be the latest set of data received. In this case the read command will show the value of <n> to be 1 as this is an intermediate stage only. In this case the buffered unsolicited response will be displayed as intermediate result.
<card_slot>
integer type, indicates the physical card slot on which the data is received. Refer +CSUS in subclause 8.66.
<LSI>
integer type, indicates the logical secure element interface as defined in ETSI TS 102 221 [60].
<payload>
hexadecimal string format, indicates the data field part of the command or response APDU data exchanged between the nrUSIM and the MT.
<filter_type>
integer type, indicating the type of filter to be chosen. Based on the value of <filter_type>, the following parameters must be provided by the user. For example, if the <filter_type> is set then the <no_of_ins> followed by the required <ins> should be provided.
0
no filter.
1
instruction-based filter where only the one or more, provided set of instruction bytes will be considered and presented.
<no_of_ins>
integer type, indicating the number of instruction(s) followed by this parameter that needs to be considered for filtering.
<ins>
integer type, indicating Instruction byte of command APDU. See ETSI TS 102 221 [60], clause 10.1.2.
Implementation
Optional.
Up

Up   Top   ToC