lpac is a cross platform local profile agent program.

Features:

• Support Activate Code and Confirm Code
• Support custom IMEI sent to server
• Support eSIM Discovery (Push Model)
• Profile management: list, enable, disable, delete and nickname
• Notification management: list, send and delete
• Lookup eUICC chip info
• etc

Download: Github Release

lpac is dynamic-linked, Release is built by Github action, if you can't run it you need to compile by yourself

sudo apt install build-essential cmake git g++ libpcsclite-dev libcurl4-openssl-dev
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac && mkdir build && cd build 
cmake ..
make

git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac && mkdir build && cd build 
cmake .. 
make

git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac && mkdir build && cd build
cmake -DCYGWIN=ON .. && make
# Download libcurl
wget https://curl.se/windows/dl-8.4.0_6/curl-8.4.0_6-win64-mingw.zip -O curl.zip && unzip curl.zip && mv curl-8.4.0_6-win64-mingw/bin/libcurl-x64.dll output/libcurl.dll

sudo apt install build-essential cmake git g++ libpcsclite-dev libcurl4-openssl-dev gcc-mingw-w64 g++-mingw-w64
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac && mkdir build && cd build
cmake -DLINUX_MINGW32=ON .. && make
# Download libcurl
wget https://curl.se/windows/dl-8.4.0_6/curl-8.4.0_6-win64-mingw.zip -O curl.zip && unzip curl.zip && mv curl-8.4.0_6-win64-mingw/bin/libcurl-x64.dll output/libcurl.dll

pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-gcc
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac && mkdir build && cd build
cmake -DLINUX_MINGW32=ON .. && ninja
# Download libcurl
wget https://curl.se/windows/dl-8.4.0_6/curl-8.4.0_6-win64-mingw.zip -O curl.zip && unzip curl.zip && mv curl-8.4.0_6-win64-mingw/bin/libcurl-x64.dll output/libcurl.dll

In Linux, you need install pcscd, pcsclite and libcurl.

APDU and HTTP interfaces of lpac has serval backends, you need specify $APDU_INTERFACE and $HTTP_INTERFACE environment variable to interface library path. If not specified, it will use libapduinterface_pcsc and libhttpinterface_curl.

APDU Backends:

• libapduinterface_at: use AT commands interface used by LTE module
• libapduinterface_pcsc: use PC/SC Smart Card API
• libapduinterface_stdio: use standard input/output

Using libapduinterface_at need access permission to serial port (normally /dev/ttyUSBx). On Arch Linux, you can add yourself to uucp group by sudo usermod -aG uucp $USER. On other distro, you may need add yourself into dialout group.

HTTP Backends:

• libhttpinterface_curl: use libcurl
• libhttpinterface_stdio: use standard input/ouput

lpac <subcommand> [subcommand] [parameters]
  subcommand:
    chip          View and manage information about your eUICC card itself
    profile       Manage the profile of your eUICC card
    notification  Manage notifications within your eUICC card
    driver        View backend info
  subcommand 2:
    Please refer to the detailed instructions below

The return contents of lpac instructions are all in json format, and the returns of all instructions comply with the following format.

{
   "type": "lpa",
   "payload": {
      "code": 0,
      "message": "success",
      "data": {[]}
   }
}

• "type": "lpa": fixed content
• code: if is 0, indicating successful execution, and other values are error codes.
• message: is success if the operation is successful, or the error type is returned if an error occurs.
• data: returns the returned content when the operation is successful, and is empty (but not NULL) when there is an error.

View the EID, default SM-DP+ server and SM-DS server of eUICC. euicc_info2 is also supported.

lpac chip <subcommand> [parameters]
  subcommand:
    info         View information about your eUICC card itself
    defaultsmdp  Modify the default SM-DP+ server address of your eUICC card
                 Example: lpac chip defaultsmdp <the address of the SM-DP+ server you want to modify>
    purge        Reset the eUICC and will clear all profiles. Use with caution!

{
  "type": "lpa",
  "payload": {
    "code": 0,
    "message": "success",
    "data": {
      "eid": " EID  ",
      "default_smds": "testrootsmds.gsma.com",
      "default_smdp": "",
      "euicc_info2": {
        "profile_version": "2.1.0",
        "sgp22_version": "2.2.0",
        "euicc_firmware_version": "4.6.0",
        "uicc_firmware_version": "9.2.0",
        "global_platform_version": "2.3.0",
        "protection_profile_version": "0.0.1",
        "sas_accreditation_number": "GI-BA-UP-0419",
        "free_nvram": 295424,
        "free_ram": 295424
      }
    }
  }
}

Profile management, you can list, set alias (nickname), enable, disable, delete, download and discovery Profiles.

lpac profile <subcommand> [parameters]
  subcommand:
    list      enumerates your eUICC Profile
    nickname  sets an alias for the specified Profile
              Example: lpac profile nickname <ICCID of Profile> <alias>
    enable    enables the specified Profile. The RefreshFlag status is enabled by default and can be omitted.
              Example: lpac profile enable <ICCID/AID of Profile> [1/0]
    disable   disables the specified Profile. The RefreshFlag state is enabled by default and can be omitted.
              Example: lpac profile disable <ICCID/AID of Profile> [1/0]
    delete    deletes the specified Profile
              Example: lpac profile delete <ICCID/AID of Profile>
    download  Pull method to download new Profile
    discovery Push method to download Profiles

There is no secondary confirmation for deleting a Profile, so please perform it with caution.

• -s: SM-DP+ server, optional, if not provided, it will try to read the defaultsmdp attribute.
• -m: Matching ID, activation code. optional.
• -c: Confirmation Code, optional.
• -i: The IMEI of the device to which Profile is to be downloaded, optional.

The following parameters can be used to customize the IMEI and SM-DS server:

• -s: SM-DS server. If not provided, it will be gsma official server "lpa.ds.gsma.com"
• -i: IMEI of the device to which Profile is to be downloaded, optional

{
   "type": "lpa", 
   "payload": {
      "code": 0, 
      "message": "success", 
      "data": [
         {
            "iccid": "8999990000... ",
            "isdpAid": "A0000005591010...",
            "profileState": 1,
            "profileNickname": "tel-u",
            "serviceProviderName": "eSIM",
            "profileName": "NEWARE_CUG_V001",
            "profileClass": 2
         }, 
         {
            "iccid": "894447860000...", 
            "isdpAid": "A0000005591011...", 
            "profileState": 0,
            "serviceProviderName": "BetterRoaming", 
            "profileName": "BetterRoaming", 
            "profileClass": 2
         }
      ]
   }
}

Used for the management of Notifications, which are sent by telecom operators during Profile operations. You can enumerate (list), send (process), and remove (remove) Notifications.

lpac notification <subcommand> [parameters]
  subcommand:
    list     Enumerates your eUICC pending Notification list
    process  Send Notification
             Example: lpac notification process <sequence ID>
    remove   Remove Notification
             Example: lpac notification remove <sequence ID>

{
   "type": "lpa",
   "payload": {
      "code": 0,
      "message": "success",
      "data": [
         {
            "seqNumber": 7,
            "profileManagementOperation": 32,
            "notificationAddress": "rsp-eu.simlessly.com",
            "iccid": "8999990000"
         },
         {
            "seqNumber": 8,
            "profileManagementOperation": 64,
            "notificationAddress": "rsp.truphone.com",
            "iccid": "894447860000"
         }
      ]
   }
}

Now there is only one command: lpac driver apdu list to get card reader list.

AGPL-3.0 Copyright (c) 2023-2024 eSTKme Group