Project

General

Profile

VoLTE IMS Android Carrier Privileges » History » Version 1

herlesupreeth, 01/19/2020 05:46 PM

1 1 herlesupreeth
h1. VoLTE IMS Android Carrier Privileges / CoIMS (Carrier Config overriding IMS settings)
2 1 herlesupreeth
3 1 herlesupreeth
Guide for overriding IMS settings to force enable VoLTE/VoWiFi using Carrier Privileges
4 1 herlesupreeth
5 1 herlesupreeth
(this guide by Supreeth Herle was first published at https://github.com/herlesupreeth/CoIMS_Wiki and is reproduce here with permission)
6 1 herlesupreeth
7 1 herlesupreeth
h2. Requirements
8 1 herlesupreeth
9 1 herlesupreeth
* 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
10 1 herlesupreeth
** [[sysmoUSIM-SJS1]] is a known-working, publicly available option
11 1 herlesupreeth
* VoLTE/VoWiFi capable phone with Android Pie or above
12 1 herlesupreeth
* PCSC, serial card reader (SIM card programmer)
13 1 herlesupreeth
* Java v1.8
14 1 herlesupreeth
15 1 herlesupreeth
h2. My Setup
16 1 herlesupreeth
17 1 herlesupreeth
* [[sysmoUSIM-SJS1]]-4ff USIM with ADM keys
18 1 herlesupreeth
* OnePlus 5t UE with Android Pie
19 1 herlesupreeth
* Gemalto SIM programmer
20 1 herlesupreeth
21 1 herlesupreeth
h2. Big shout out and credits to following people for their awesome work
22 1 herlesupreeth
23 1 herlesupreeth
"Martin Paljak":https://github.com/martinpaljak for GlobalPlatformPro (gp.jar) - A tool to load and manage applets on compatible JavaCards from command line
24 1 herlesupreeth
25 1 herlesupreeth
"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
26 1 herlesupreeth
27 1 herlesupreeth
h2. Steps
28 1 herlesupreeth
29 1 herlesupreeth
h3. Step 1: Clone repository and fetch details of the SIM
30 1 herlesupreeth
31 1 herlesupreeth
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
32 1 herlesupreeth
33 1 herlesupreeth
<pre>
34 1 herlesupreeth
$ git clone https://github.com/herlesupreeth/CoIMS_Wiki
35 1 herlesupreeth
$ cd CoIMS_Wiki
36 1 herlesupreeth
$ alias gp="java -jar $PWD/gp.jar"
37 1 herlesupreeth
</pre>
38 1 herlesupreeth
39 1 herlesupreeth
Example: In [[sysmoUSIM-SJS1]]-4ff USIM cards, the key mappings for GlobalPlatformPro are as follows
40 1 herlesupreeth
|_.sysmoUSIM key |_.GlobalPlatformPro argument |
41 1 herlesupreeth
|KIC1|--key-enc|
42 1 herlesupreeth
|KID1|--key-mac|
43 1 herlesupreeth
|KIK1|--key-dek|
44 1 herlesupreeth
45 1 herlesupreeth
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
46 1 herlesupreeth
<pre>
47 1 herlesupreeth
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -lvi
48 1 herlesupreeth
</pre>
49 1 herlesupreeth
50 1 herlesupreeth
h3. Step 2: Unlock the SIM card for easier installation of applet as follows (Optional)
51 1 herlesupreeth
52 1 herlesupreeth
*Proceed with caution when unlocking SIM card as it could brick your USIM/ISIM if incorrect KIC1, KID1 and KIK1 keys are used*
53 1 herlesupreeth
<pre>
54 1 herlesupreeth
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 --unlock
55 1 herlesupreeth
</pre>
56 1 herlesupreeth
57 1 herlesupreeth
Example: A sysmoUSIM-SJS1-4ff USIM card with following keys is unlocked as follows
58 1 herlesupreeth
59 1 herlesupreeth
KIC1 = --key-enc = 975B496CED1F2FB984145A55AB31A585
60 1 herlesupreeth
61 1 herlesupreeth
KID1 = --key-mac = E7207B567F9D08726A6EFBD90C50DA9A
62 1 herlesupreeth
63 1 herlesupreeth
KIK1 = --key-dek = DEAA4E9A9B3BC6FC5EFF77A8E9925632
64 1 herlesupreeth
65 1 herlesupreeth
<pre>
66 1 herlesupreeth
$ gp --key-enc 975B496CED1F2FB984145A55AB31A585 --key-mac E7207B567F9D08726A6EFBD90C50DA9A --key-dek DEAA4E9A9B3BC6FC5EFF77A8E9925632 --unlock
67 1 herlesupreeth
Default type=DES3 bytes=404142434445464748494A4B4C4D4E4F kcv=8BAF47 set as master key for A000000003000000
68 1 herlesupreeth
</pre>
69 1 herlesupreeth
70 1 herlesupreeth
h3. Step 3: Install ARA-M Java Card applets on USIM/ISIM
71 1 herlesupreeth
72 1 herlesupreeth
*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*
73 1 herlesupreeth
74 1 herlesupreeth
Install the ARA-M applet (applet.cap). The following command must execute without any errors.
75 1 herlesupreeth
76 1 herlesupreeth
<pre>
77 1 herlesupreeth
# If SIM is not unlocked in Step 2
78 1 herlesupreeth
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 --install applet.cap
79 1 herlesupreeth
# If SIM is unlocked in Step 2
80 1 herlesupreeth
$ gp --install applet.cap
81 1 herlesupreeth
</pre>
82 1 herlesupreeth
83 1 herlesupreeth
h3. Step 4: Push the SHA-1 certifcate of the Carrier Config Android app onto ARA-M in USIM/ISIM
84 1 herlesupreeth
85 1 herlesupreeth
The Carrier Config Android app which will be installed in Step 5 is signed with following SHA1 key
86 1 herlesupreeth
87 1 herlesupreeth
SHA1: E4:68:72:F2:8B:35:0B:7E:1F:14:0D:E5:35:C2:A8:D5:80:4F:0B:E3
88 1 herlesupreeth
89 1 herlesupreeth
In order to provide Carrier Privileges to Carrier Config app, push the above SHA1 certifcate as follows
90 1 herlesupreeth
91 1 herlesupreeth
<pre>
92 1 herlesupreeth
# If SIM is not unlocked in Step 2
93 1 herlesupreeth
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -a 00A4040009A00000015141434C0000 -a 80E2900033F031E22FE11E4F06FFFFFFFFFFFFC114E46872F28B350B7E1F140DE535C2A8D5804F0BE3E30DD00101DB080000000000000001
94 1 herlesupreeth
# If SIM is unlocked in Step 2
95 1 herlesupreeth
$ gp -a 00A4040009A00000015141434C0000 -a 80E2900033F031E22FE11E4F06FFFFFFFFFFFFC114E46872F28B350B7E1F140DE535C2A8D5804F0BE3E30DD00101DB080000000000000001
96 1 herlesupreeth
</pre>
97 1 herlesupreeth
98 1 herlesupreeth
The split-up of above APDU sent to SIM card is as follows
99 1 herlesupreeth
100 1 herlesupreeth
<pre>
101 1 herlesupreeth
#### REF-AR-DO for UICC Carrier Privileges
102 1 herlesupreeth
103 1 herlesupreeth
|REF-AR-DO|T|E2    | |                  | |                                        |
104 1 herlesupreeth
|         |L|2F    | |                  | |                                        |
105 1 herlesupreeth
|         |V|REF-DO|T|E1                | |                                        |
106 1 herlesupreeth
|         | |      |L|1E                | |                                        |
107 1 herlesupreeth
|         | |      |V|AID-REF-DO        |T|4F                                      |
108 1 herlesupreeth
|         | |      | |                  |L|06                                      |
109 1 herlesupreeth
|         | |      | |                  |V|FFFFFFFFFFFF                            |
110 1 herlesupreeth
|         | |      | |DeviceAppID-REF-DO|T|C1                                      |
111 1 herlesupreeth
|         | |      | |                  |L|14                                      |
112 1 herlesupreeth
|         | |      | |                  |V|E46872F28B350B7E1F140DE535C2A8D5804F0BE3|
113 1 herlesupreeth
|         | |AR-DO |T|E3                | |                                        |
114 1 herlesupreeth
|         | |      |L|0D                | |                                        |
115 1 herlesupreeth
|         | |      |V|APDU-AR-DO        |T|D0                                      |
116 1 herlesupreeth
|         | |      | |                  |L|01                                      |
117 1 herlesupreeth
|         | |      | |                  |V|01 (Always)                             |
118 1 herlesupreeth
|         | |      | |PERM-AR-DO        |T|DB                                      |
119 1 herlesupreeth
|         | |      | |                  |L|08                                      |
120 1 herlesupreeth
|         | |      | |                  |V|0000000000000001                        |
121 1 herlesupreeth
</pre>
122 1 herlesupreeth
123 1 herlesupreeth
To check the list of installed certificates use the following command
124 1 herlesupreeth
125 1 herlesupreeth
<pre>
126 1 herlesupreeth
# If SIM is not unlocked in Step 2
127 1 herlesupreeth
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -acr-list
128 1 herlesupreeth
RULE #0 :
129 1 herlesupreeth
       AID  : FFFFFFFFFFFF
130 1 herlesupreeth
       HASH : E46872F28B350B7E1F140DE535C2A8D5804F0BE3
131 1 herlesupreeth
       APDU rule   : ALWAYS(0x01)
132 1 herlesupreeth
# If SIM is unlocked in Step 2
133 1 herlesupreeth
$ gp -acr-list
134 1 herlesupreeth
RULE #0 :
135 1 herlesupreeth
       AID  : FFFFFFFFFFFF
136 1 herlesupreeth
       HASH : E46872F28B350B7E1F140DE535C2A8D5804F0BE3
137 1 herlesupreeth
       APDU rule   : ALWAYS(0x01)
138 1 herlesupreeth
</pre>
139 1 herlesupreeth
140 1 herlesupreeth
_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_
141 1 herlesupreeth
142 1 herlesupreeth
h3. Step 5: Install the Carrier Config Android app from Play Store
143 1 herlesupreeth
144 1 herlesupreeth
Make sure the SIM card is placed in the default/first SIM slot of the device (only for multi-sim capable devices)
145 1 herlesupreeth
146 1 herlesupreeth
Download the "CoIMS":https://play.google.com/store/apps/details?id=com.sherle.coims Carrier Config app from play store. Then, run the app
147 1 herlesupreeth
148 1 herlesupreeth
Important points/values to note after running the app for this app to enable VoLTE
149 1 herlesupreeth
150 1 herlesupreeth
* "App has Carrier Privileges" must be true
151 1 herlesupreeth
* "SIM Carrier Id" must not be -1 (i.e Unknown Carrier)
152 1 herlesupreeth
* "carrier_volte_provisioned_bool" must be true
153 1 herlesupreeth
154 1 herlesupreeth
h2. Debugging
155 1 herlesupreeth
156 1 herlesupreeth
Use adb debugging with filter for "ims" keyword
157 1 herlesupreeth
158 1 herlesupreeth
h3. Potential reasons for this method not working
159 1 herlesupreeth
160 1 herlesupreeth
# If the value of CarrierIdentifier indicated in the app is -1 (i.e Unknown Carrier)
161 1 herlesupreeth
#* 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
162 1 herlesupreeth
#*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)
163 1 herlesupreeth
# Some devices with Samsung Exynos chipset/ Mediatek chipset require ISIM, only USIM is not enough for SIP registrations
164 1 herlesupreeth
# Does not seem to work on Samsung devices with Exynos chipset
165 1 herlesupreeth
# 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)