Project

General

Profile

VoLTE IMS Android Carrier Privileges » History » Version 3

laforge, 01/27/2020 01:26 PM

1 1 herlesupreeth
h1. VoLTE IMS Android Carrier Privileges / CoIMS (Carrier Config overriding IMS settings)
2
3 3 laforge
In general, 3GPP specifications do not require any specific SIM card in order to use VoLTE or IMS.
4
5
However, unfortunately handset manufacturers don't seem to care much about 3GPP specifications and introduce all kinds of strange mechanisms in order to restrict the use of VoLTE/IMS to certain operators - whether by using explicit white-lists, or by coming up with mechanisms like Android Carrier Privileges to disallow the user from configuring IMS credentials on his phone.
6
7
This is a guide for overriding IMS settings to force enable VoLTE/VoWiFi using "Android Carrier Privileges":https://source.android.com/devices/tech/config/uicc
8 2 laforge
9
h2. Overview
10
11
* Android provides some APIs only to Android Apps by the operator
12
* Android identifies such Apps via the signing key with which they were signed
13
* The signing key (well, a hash of it) is stored on the SIM card
14
* This storage is not done as a simple file on the SIM filesystem, but in some special additional card application on the SIM-Card, a so-called ARA-M
15
** There is an Open Source implementation of this applet by Bertrand Martel at https://github.com/bertrandmartel/aram-applet
16
17
This document describes how to put everything together
18 1 herlesupreeth
19
(this guide by Supreeth Herle was first published at https://github.com/herlesupreeth/CoIMS_Wiki and is reproduce here with permission)
20
21
h2. Requirements
22
23
* A programmable version of USIM/ISIM with KIC1, KID1 and KIK1, or a non-programmable USIM/ISIM with ARA-M application but with option to push certficates to ARA-M via OTA
24
** [[sysmoUSIM-SJS1]] is a known-working, publicly available option
25
* VoLTE/VoWiFi capable phone with Android Pie or above
26
* PCSC, serial card reader (SIM card programmer)
27
* Java v1.8
28
29
h2. My Setup
30
31
* [[sysmoUSIM-SJS1]]-4ff USIM with ADM keys
32
* OnePlus 5t UE with Android Pie
33
* Gemalto SIM programmer
34
35
h2. Big shout out and credits to following people for their awesome work
36
37
"Martin Paljak":https://github.com/martinpaljak for GlobalPlatformPro (gp.jar) - A tool to load and manage applets on compatible JavaCards from command line
38
39
"Bertrand Martel":https://github.com/bertrandmartel/aram-applet for ARA-M applet (applet.cap) - ARA-M implementation for JavaCards. ARA-M is an application (typically present on a SIM card) which manage access rules that are enforced by an Access Control Enforcer (typically present on Android device). The enforcer makes sure the rules from the ARAM are enforced. An access rule is composed of an AID, a certificate hash (SHA1/SHA256 of client application cert) and a set of rules. The Access Control enforcer will allow/deny a client application (for example an Android app) to send APDU to a Secure Element (SE) applet based on these rules
40
41
h2. Steps
42
43
h3. Step 1: Clone repository and fetch details of the SIM
44
45
In order to install and/or manage Java Card applets on your SIM card, make sure to have KIC1, KID1 and KIK1 keys. KIC1, KID1 and KIK1 could differ from one SIM card to another so make sure to have the correct keys. If you have a non-programmable USIM/ISIM with ARA-M application and have option to push certficates to ARA-M via OTA, jump to Step 4
46
47
<pre>
48
$ git clone https://github.com/herlesupreeth/CoIMS_Wiki
49
$ cd CoIMS_Wiki
50
$ alias gp="java -jar $PWD/gp.jar"
51
</pre>
52
53
Example: In [[sysmoUSIM-SJS1]]-4ff USIM cards, the key mappings for GlobalPlatformPro are as follows
54
|_.sysmoUSIM key |_.GlobalPlatformPro argument |
55
|KIC1|--key-enc|
56
|KID1|--key-mac|
57
|KIK1|--key-dek|
58
59
Fetch details of the SIM by replacing KIC1, KID1 and KIK1 with correct keys respective to your SIM card. Execution of below command should not result in any error. If there is an error, please check the error and double check everything before proceeding
60
<pre>
61
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -lvi
62
</pre>
63
64
h3. Step 2: Unlock the SIM card for easier installation of applet as follows (Optional)
65
66
*Proceed with caution when unlocking SIM card as it could brick your USIM/ISIM if incorrect KIC1, KID1 and KIK1 keys are used*
67
<pre>
68
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 --unlock
69
</pre>
70
71
Example: A sysmoUSIM-SJS1-4ff USIM card with following keys is unlocked as follows
72
73
KIC1 = --key-enc = 975B496CED1F2FB984145A55AB31A585
74
75
KID1 = --key-mac = E7207B567F9D08726A6EFBD90C50DA9A
76
77
KIK1 = --key-dek = DEAA4E9A9B3BC6FC5EFF77A8E9925632
78
79
<pre>
80
$ gp --key-enc 975B496CED1F2FB984145A55AB31A585 --key-mac E7207B567F9D08726A6EFBD90C50DA9A --key-dek DEAA4E9A9B3BC6FC5EFF77A8E9925632 --unlock
81
Default type=DES3 bytes=404142434445464748494A4B4C4D4E4F kcv=8BAF47 set as master key for A000000003000000
82
</pre>
83
84
h3. Step 3: Install ARA-M Java Card applets on USIM/ISIM
85
86
*Proceed with caution when installing applets on SIM card as it could brick your USIM/ISIM if incorrect KIC1, KID1 and KIK1 keys are used*
87
88
Install the ARA-M applet (applet.cap). The following command must execute without any errors.
89
90
<pre>
91
# If SIM is not unlocked in Step 2
92
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 --install applet.cap
93
# If SIM is unlocked in Step 2
94
$ gp --install applet.cap
95
</pre>
96
97
h3. Step 4: Push the SHA-1 certifcate of the Carrier Config Android app onto ARA-M in USIM/ISIM
98
99
The Carrier Config Android app which will be installed in Step 5 is signed with following SHA1 key
100
101
SHA1: E4:68:72:F2:8B:35:0B:7E:1F:14:0D:E5:35:C2:A8:D5:80:4F:0B:E3
102
103
In order to provide Carrier Privileges to Carrier Config app, push the above SHA1 certifcate as follows
104
105
<pre>
106
# If SIM is not unlocked in Step 2
107
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -a 00A4040009A00000015141434C0000 -a 80E2900033F031E22FE11E4F06FFFFFFFFFFFFC114E46872F28B350B7E1F140DE535C2A8D5804F0BE3E30DD00101DB080000000000000001
108
# If SIM is unlocked in Step 2
109
$ gp -a 00A4040009A00000015141434C0000 -a 80E2900033F031E22FE11E4F06FFFFFFFFFFFFC114E46872F28B350B7E1F140DE535C2A8D5804F0BE3E30DD00101DB080000000000000001
110
</pre>
111
112
The split-up of above APDU sent to SIM card is as follows
113
114
<pre>
115
#### REF-AR-DO for UICC Carrier Privileges
116
117
|REF-AR-DO|T|E2    | |                  | |                                        |
118
|         |L|2F    | |                  | |                                        |
119
|         |V|REF-DO|T|E1                | |                                        |
120
|         | |      |L|1E                | |                                        |
121
|         | |      |V|AID-REF-DO        |T|4F                                      |
122
|         | |      | |                  |L|06                                      |
123
|         | |      | |                  |V|FFFFFFFFFFFF                            |
124
|         | |      | |DeviceAppID-REF-DO|T|C1                                      |
125
|         | |      | |                  |L|14                                      |
126
|         | |      | |                  |V|E46872F28B350B7E1F140DE535C2A8D5804F0BE3|
127
|         | |AR-DO |T|E3                | |                                        |
128
|         | |      |L|0D                | |                                        |
129
|         | |      |V|APDU-AR-DO        |T|D0                                      |
130
|         | |      | |                  |L|01                                      |
131
|         | |      | |                  |V|01 (Always)                             |
132
|         | |      | |PERM-AR-DO        |T|DB                                      |
133
|         | |      | |                  |L|08                                      |
134
|         | |      | |                  |V|0000000000000001                        |
135
</pre>
136
137
To check the list of installed certificates use the following command
138
139
<pre>
140
# If SIM is not unlocked in Step 2
141
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -acr-list
142
RULE #0 :
143
       AID  : FFFFFFFFFFFF
144
       HASH : E46872F28B350B7E1F140DE535C2A8D5804F0BE3
145
       APDU rule   : ALWAYS(0x01)
146
# If SIM is unlocked in Step 2
147
$ gp -acr-list
148
RULE #0 :
149
       AID  : FFFFFFFFFFFF
150
       HASH : E46872F28B350B7E1F140DE535C2A8D5804F0BE3
151
       APDU rule   : ALWAYS(0x01)
152
</pre>
153
154
_If you have a non-programmable USIM/ISIM with ARA-M application and have option to push certficates to ARA-M via OTA, push the above SHA1 certificate on to the SIM_
155
156
h3. Step 5: Install the Carrier Config Android app from Play Store
157
158
Make sure the SIM card is placed in the default/first SIM slot of the device (only for multi-sim capable devices)
159
160
Download the "CoIMS":https://play.google.com/store/apps/details?id=com.sherle.coims Carrier Config app from play store. Then, run the app
161
162
Important points/values to note after running the app for this app to enable VoLTE
163
164
* "App has Carrier Privileges" must be true
165
* "SIM Carrier Id" must not be -1 (i.e Unknown Carrier)
166
* "carrier_volte_provisioned_bool" must be true
167
168
h2. Debugging
169
170
Use adb debugging with filter for "ims" keyword
171
172
h3. Potential reasons for this method not working
173
174
# If the value of CarrierIdentifier indicated in the app is -1 (i.e Unknown Carrier)
175
#* If PLMN is on the following list (https://android.googlesource.com/platform/packages/providers/TelephonyProvider/+/master/assets/carrier_list.textpb) Resolution: Wait for vendor to release an update and hopefully it contains the updated carrier list
176
#*If PLMN is not on the following list (https://android.googlesource.com/platform/packages/providers/TelephonyProvider/+/master/assets/carrier_list.textpb) Resolution: Refer the following link (https://source.android.com/devices/tech/config/carrierid#integrating_carrier_ids_with_carrierconfig)
177
# Some devices with Samsung Exynos chipset/ Mediatek chipset require ISIM, only USIM is not enough for SIP registrations
178
# Does not seem to work on Samsung devices with Exynos chipset
179
# If the SIM is placed in non-default SIM slot in a multi-SIM phones i.e. SIM in slot 1 (SIM slot 0 (default), SIM slot 1) of device
Add picture from clipboard (Maximum size: 48.8 MB)