Original link: https://osmocom.org/projects/cellular-infrastructure/wiki/VoLTE_IMS_Android_Carrier_Privileges
In general, 3GPP specifications do not require any specific SIM card in order to use VoLTE or IMS.
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.
This is a guide for overriding IMS settings to force enable VoLTE/VoWiFi using Android Carrier Privileges
Overview
Android provides some APIs only to Android Apps by the operator
Android identifies such Apps via the signing key with which they were signed
The signing key (well, a hash of it) is stored on the SIM card
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
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
sysmoUSIM-SJS1 is a known-working, publicly available option
VoLTE/VoWiFi capable phone with Android Pie or above
PCSC, serial card reader (SIM card programmer)
Java v1.8
My Setup
sysmoUSIM-SJS1-4ff USIM with ADM keys OnePlus 5t UE with Android Pie Gemalto SIM programmer
Big shout out and credits to following people for their awesome work
Martin Paljak for GlobalPlatformPro (gp.jar) - A tool to load and manage applets on compatible JavaCards from command line
Bertrand Martel 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
Steps
Step 1: Clone repository and fetch details of the SIM 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
$ git clone https://github.com/herlesupreeth/CoIMS_Wiki
$ cd CoIMS_Wiki
$ alias gp="java -jar $PWD/gp.jar"
Example: In sysmoUSIM-SJS1-4ff USIM cards, the key mappings for GlobalPlatformPro are as follows
sysmoUSIM key
GlobalPlatformPro argument
KIC1
--key-enc
KID1
--key-mac
KIK1
--key-dek
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
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -lvi
Step 2: Unlock the SIM card for easier installation of applet as follows (Optional) Proceed with caution when unlocking SIM card as it could brick your USIM/ISIM if incorrect KIC1, KID1 and KIK1 keys are used
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 --unlock
Example: A sysmoUSIM-SJS1-4ff USIM card with following keys is unlocked as follows
$ gp --key-enc 975B496CED1F2FB984145A55AB31A585 --key-mac E7207B567F9D08726A6EFBD90C50DA9A --key-dek DEAA4E9A9B3BC6FC5EFF77A8E9925632 --unlock
Default type=DES3 bytes=404142434445464748494A4B4C4D4E4F kcv=8BAF47 set as master key for A000000003000000
Step 3: Install ARA-M Java Card applets on USIM/ISIM 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
Install the ARA-M applet (applet.cap). The following command must execute without any errors.
# If SIM is not unlocked in Step 2
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 --install applet.cap
# If SIM is unlocked in Step 2
$ gp --install applet.cap
Step 4: Push the SHA-1 certifcate of the Carrier Config Android app onto ARA-M in USIM/ISIM The Carrier Config Android app which will be installed in Step 5 is signed with following SHA1 key
In order to provide Carrier Privileges to Carrier Config app, push the above SHA1 certifcate as follows
# If SIM is not unlocked in Step 2
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -a 00A4040009A00000015141434C0000 -a 80E2900033F031E22FE11E4F06FFFFFFFFFFFFC114E46872F28B350B7E1F140DE535C2A8D5804F0BE3E30DD00101DB080000000000000001
# If SIM is unlocked in Step 2
$ gp -a 00A4040009A00000015141434C0000 -a 80E2900033F031E22FE11E4F06FFFFFFFFFFFFC114E46872F28B350B7E1F140DE535C2A8D5804F0BE3E30DD00101DB080000000000000001
The split-up of above APDU sent to SIM card is as follows
To check the list of installed certificates use the following command
# If SIM is not unlocked in Step 2
$ gp --key-enc KIC1 --key-mac KID1 --key-dek KIK1 -acr-list
RULE #0 :
AID : FFFFFFFFFFFF
HASH : E46872F28B350B7E1F140DE535C2A8D5804F0BE3
APDU rule : ALWAYS(0x01)
# If SIM is unlocked in Step 2
$ gp -acr-list
RULE #0 :
AID : FFFFFFFFFFFF
HASH : E46872F28B350B7E1F140DE535C2A8D5804F0BE3
APDU rule : ALWAYS(0x01)
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
Step 5: Install the Carrier Config Android app from Play Store Make sure the SIM card is placed in the default/first SIM slot of the device (only for multi-sim capable devices) Download the CoIMS Carrier Config app from play store. Then, run the app
Important points/values to note after running the app for this app to enable VoLTE
"App has Carrier Privileges" must be true
"SIM Carrier Id" must not be -1 (i.e Unknown Carrier)
"carrier_volte_provisioned_bool" must be true
Debugging Use adb debugging with filter for "ims" keyword
Potential reasons for this method not working
If the value of CarrierIdentifier indicated in the app is -1 (i.e Unknown Carrier)
