lpac-libmbim-wrapper

This is a wrapper for the LPAC client that uses mbimcli to manage eUICC (eSIM) on Linux.

Acknowledgments

I want to extend a big thanks to @z3ntu for his original work. I've just rewritten the parser to make it work with mbimcli.

How to use

• Install LPAC.
• Install dependencies:

sudo apt update
sudo apt install python3-pip libmbim-utils

• Install lpac-libmbim-wrapper:

sudo pip3 install git+https://github.com/stich86/lpac-libmbim-wrapper.git

• Use sudo lpac-mbim [--device=/dev/<MBIM device>] {lpac commands}.

Some examples:

To display a list of installed profiles, simply type:

sudo lpac-mbim profile list

Output:

INFO: Connect
INFO: Open channel with AID a0000005591010ffffffff8900000100
INFO: Received LPA data. Printing...
{'payload': {'code': 0,
             'data': [{'iccid': '89XXXXXXXXXXXXX',
                       'icon': None,
                       'iconType': None,
                       'isdpAid': 'a0000005591010ffffffff8900001100',
                       'profileClass': 'operational',
                       'profileName': 'Tata_EP3303v3_TEA02759_TEA02760_Firsty_20K',
                       'profileNickname': None,
                       'profileState': 'enabled',
                       'serviceProviderName': 'Firsty'}],
             'message': 'success'},
 'type': 'lpa'}
INFO: Close channel 01
INFO: Disconnect
Exit code: 0

All other commands are based on LPAC binary.

Modems tested

Here is a list of tests that I've done, both with embedded and physical eSIM:

Modem Tested	e-SIM		APDU backend			Firmware
	Internal	External	AT	MBIM	QMI	ATI Output
Foxconn T99W175 (Lenovo version)	✅	✅	❌	✅	❌	F0.1.0.0.9.VF.008
Quectel RM502Q-GL	N/A	✅	⚠️	✅	❔	RM502QGLAAR11A02M4G
Quectel EP06-E	N/A	✅	N/A	✅	❔	EP06ELAR04A05M4G
APAL MiFi 5G Router (90D5 USB Composition)	N/A	✅	❌	✅	N/A	AXDG1.20.00_181_0R00

When using Foxconn T99W175 select the correct slot based on type of eSIM you are using (slot 0=Physical SIM, slot 1=Embedded eSIM) You can swap slot with mbimcli using this command:

sudo mbimcli -p -d /dev/wwan0mbim0 --ms-set-device-slot-mappings=1

If you want to know which slot is active, just type:

sudo mbimcli -p -d /dev/wwan0mbim0 --ms-query-device-slot-mappings

For AT provisioning, the modem needs these commands to interact with the eUICC:

• AT+CCHO to open logical channel
• AT+CCHC to close logical channel
• AT+CGLA to use logical channel access

Foxconn T99W175 lacks AT commands, while Quectel RM502Q-GL/EP06-E seems to work only for this subset:

• Chip Info
• List Profile
• Enable/Disable Profile
• Delete Profile
• Notification List

Download Profile, Notification Remove and Notification Process didn't work on my attempts.

⚠️ This wrapper is not needed if you want to use APDU AT backend. ⚠️

OpenWRT support

Wrapper can run also on OpenWRT, but you need to make some change:

• compile libcurl and lpac using OpenSSL and not MbedTLS. lpac package can be added to your build using this fork
• install Python package python3-light (requires ~4.10 MiB with dependencies on average OpenWrt system)
• copy lpac-mbim into /usr/bin and make it executable chmod +x lpac-mbim

Bugs & know issues

⚠️ Delete profile doesn't contact SM-DP+ server automatically, so it doesn't detach the eSIM profile. ⚠️

You should run these commands to release it:

Get all tasks issued on the eUICC:

sudo lpac-mbim notification list

Output:

{'payload': {'code': 0,
             'data': [{'iccid': '8931XXXXXXXXXXXXXXX',
                       'notificationAddress': 'dp-plus-par07-01.oasis-smartsim.com',
                       'profileManagementOperation': 'install',
                       'seqNumber': 6},
                      {'iccid': '8939XXXXXXXXXXXXXXX',
                       'notificationAddress': 'frm.prod.ondemandconnectivity.com',
                       'profileManagementOperation': 'disable',
                       'seqNumber': 2},
                      {'iccid': '8939XXXXXXXXXXXXXXX',
                       'notificationAddress': 'frm.prod.ondemandconnectivity.com',
                       'profileManagementOperation': 'enable',
                       'seqNumber': 3},
                      {'iccid': '8939XXXXXXXXXXXXXXX',
                       'notificationAddress': 'frm.prod.ondemandconnectivity.com',
                       'profileManagementOperation': 'disable',
                       'seqNumber': 4},
                      {'iccid': '8939XXXXXXXXXXXXXXX',
                       'notificationAddress': 'frm.prod.ondemandconnectivity.com',
                       'profileManagementOperation': 'delete',
                       'seqNumber': 5},
                      {'iccid': '8931XXXXXXXXXXXXXXX',
                       'notificationAddress': 'dp-plus-par07-01.oasis-smartsim.com',
                       'profileManagementOperation': 'enable',
                       'seqNumber': 7},
                      {'iccid': '8931XXXXXXXXXXXXXXX',
                       'notificationAddress': 'dp-plus-par07-01.oasis-smartsim.com',
                       'profileManagementOperation': 'disable',
                       'seqNumber': 8},
                      {'iccid': '8931XXXXXXXXXXXXXXX',
                       'notificationAddress': 'dp-plus-par07-01.oasis-smartsim.com',
                       'profileManagementOperation': 'delete',
                       'seqNumber': 9}],
             'message': 'success'},
 'type': 'lpa'}

Look at profileManagementOperation type delete and take note of seqNumber value, then issue the notification command to release the eSIM profile:

sudo lpac-mbim notification process 5 -r <-- this will tell remote SM-DS server to release eSIM profile for ICCID 8939XXXXXXXXXXXXXXX.

sudo lpac-mbim notification process 9 -r <-- this will tell remote SM-DS server to release eSIM profile for ICCID 8931XXXXXXXXXXXXXXX.

The flag -r will remove the task from the list.

Others

I'm not a Python expert, so it's possible that there are some bugs present. Feel free to file an issue and/or submit a pull request to enhance the code :)