estkme-rlpa-server

README

eSTK.me Remote LPA Server

Introduction

This is a simple server designed to handle requests from the eSTK.me removable eUICC, such as downloads and notifications.

The project is written in Go and is just a toy project, not suitable for production use.

If you want to deploy your own rLPA server, I recommend you to use the official rLPA server instead.

Installation

You can download the binary release from the releases page or you can build it yourself.

If you want to build it yourself, you can run the following commands:

git clone git@github.com:damonto/estkme-rlpa-server.git
cd estkme-rlpa-server
go build -trimpath -ldflags="-w -s" -o estkme-rlpa-server main.go

You can also install the latest version using the following command:

go install github.com/damonto/estkme-rlpa-server@latest

Sometimes, you might need to set executable permissions for the binary file using the following command:

chmod +x estkme-rlpa-server

You must also install the following dependencies:

# Debian
apt-get install -y --no-install-recommends ca-certificates libpcsclite1 libcurl4
# Arch Linux
pacman -S pcsclite

Once done, you can run the server using the following command:

./estkme-rlpa-server

If you want to change the default port, lpac version or data directory, you can use the following flags:

./estkme-rlpa-server --help

Usage of estkme-rlpa-server:
  -data-dir string
        data directory (default "/home/user/workspace/estkme-rlpa-server/data")
  -listen-address string
        rLPA server listen address (default ":1888")
  -lpac-version string
        lpac version (default "v2.0.0-beta.1")
  -dont-download
        don't download lpac

If you wish to run the program in the background, you can utilize the systemctl command. Here is an example of how to achieve this:

1. Start by creating a service file in the /etc/systemd/system directory. For instance, you can name the file estkme-rlpa-server.service and include the following content:

[Unit]
Description=eSTK.me rLPA Server
After=network.target

[Service]
Type=simple
User=your_user_here
Restart=on-failure
ExecStart=/your/binary/path/here/estkme-rlpa-server
RestartSec=10s
TimeoutStopSec=30s

[Install]
WantedBy=multi-user.target

1. Then, use the following command to start the service:

systemctl start estkme-rlpa-server

1. If you want the service to start automatically upon system boot, use the following command:

systemctl enable estkme-rlpa-server

Docker

You can also run the server using Docker. You can use the following command to run the server:

docker run -d --name estkme-rlpa-server -p 1888:1888 damonto/estkme-rlpa-server:latest
# or use the GitHub Container Registry
docker run -d --name estkme-rlpa-server -p 1888:1888 -v ghcr.io/damonto/estkme-rlpa-server:latest

Usage

Once the server is running, the server will listen on the specified port (default: 1888) and you can send requests to the server.

Download

To download a profile, you should enable the remote LPA feature on the eUICC and set the rLPA server URL to the server address. The server will handle the download request and download the profile to the eUICC.

The server support downloading profiles with confirmation code and custom IMEI.

If your eSIM provider requires a confirmation code, you can use the following activation code format:

LPA:1$SM-DP+$Matching Id$$<confirmation_code>

Please replace <confirmation_code> with the actual confirmation code.

If your eSIM provider requires a custom IMEI, you can use the following activation code format:

1. With confirmation code:

LPA:1$SM-DP+$Matching Id$$<confirmation_code>#<custom_imei>

1. Without confirmation code:

LPA:1$SM-DP+$Matching Id#<custom_imei>

Please replace <custom_imei> with the actual IMEI.

Notification

If you click the "Process Notification" button on the eSTK.me eUICC, the server will receive a notification request and send all notifications.

Please note that:

1. All enable, disable and install notifications will be deleted after sending.

2. The delete notifications will be kept in your eSTK.me eUICC.