Compare commits

...

107 commits
v2.0.0 ... main

Author SHA1 Message Date
Vlad Starodubtsev
187c42dfde
driver: apdu: at: don't expect space after "+CGLA:" (#238)
Some devices have a difference in format and do not add a space.

AT+CGLA=1,16,"81E2910003BF3C00"
+CGLA:4,"611A"

OK
2025-05-16 21:47:11 +08:00
Damon To
35d54c5904
chore(ci): update macOS to the latest version 2025-04-11 10:33:15 +08:00
Yegor Yefremov
e45395f527
Automatically create .gitignore in the build folder (#224)
This way, every out-of-source build folder will be ignored.
2025-04-10 11:58:27 +08:00
c979f67348
fix: add pragma once (#230) 2025-03-25 09:24:23 +08:00
Yegor Yefremov
f180f7ef7d
CMakeLists.txt: remove CMP0069 (#231)
Due to the CMake minimum version bump, this policy is enabled by
default.
2025-03-24 08:07:53 +08:00
Marius Gripsgard
4d6ca410fa
gbinder_hidl: Fix compiler warnings (and error on older gcc) (#229) 2025-03-20 16:51:44 +08:00
93ddaf4ae8
refactor: euicc init function (#222) 2025-03-20 11:26:49 +08:00
Yegor Yefremov
5e5e3f2e8a
CMakeLists.txt: bump CMake version to 3.15 (#223)
This change fixes the following warning on the latest CMake versions:

CMake Deprecation Warning at CMakeLists.txt:1 (cmake_minimum_required):
  Compatibility with CMake < 3.10 will be removed from a future version of
  CMake.

  Update the VERSION argument <min> value.  Or, use the <min>...<max> syntax
  to tell CMake that the project requires at least <min> but has been updated
  to work with policies introduced by <max> or earlier.
2025-03-20 08:18:30 +08:00
Daniel Gimpelevich
a6c5365455
Update LINUX-DIST.md (#219) 2025-03-17 19:29:43 +08:00
Luca Weiss
eeae8d1a87
driver: apdu: qmi*: Pass correct open flag for QRTR driver (#216)
While the QMI driver which goes to /dev/foobar wants to go through the
qmi-proxy to not have to exclusively claim the device, the QMI-over-QRTR
driver doesn't work with the PROXY flag and just leads to the error

  error: open QMI device failed: endpoint hangup

Fix this by passing the correct flag to qmi_device_open from both APDU
drivers.

Closes: #215
Fixes: 3bde4a1 (" driver(APDU): add QMI backend (#131)")

Co-authored-by: Luca Weiss <luca.weiss@fairphone.com>
2025-03-16 08:29:39 +08:00
Yegor Yefremov
84ba3962d7
driver/apdu/qmi.c: use calloc instead of malloc (#213)
calloc() also zeros all elements.
2025-03-15 08:56:51 +08:00
estkme
f9263ad734 update copyright and license 2025-03-13 22:59:50 +08:00
Yegor Yefremov
15b7572fbc
README.md: clarify licenses for cjson and dlfcn-win32 (#211) 2025-03-12 14:06:30 +08:00
Yegor Yefremov
208c80ef29
CMakeLists.txt: enable CMAKE_EXPORT_COMPILE_COMMANDS by default (#207)
This creates a compile_commands.json file that can then be used
by the cland tool.
2025-03-12 13:14:28 +08:00
Yegor Yefremov
f7abb97e59
docs/USAGE.md: fix grammar and typos (#210) 2025-03-10 21:50:55 +08:00
Yegor Yefremov
b599e5ab9f
fix: typo (#208) 2025-03-06 21:53:45 +08:00
Damon To
182e2e4e03
fix(driver): set correct open flags for MBIM device proxy connection (#206) 2025-03-06 10:17:50 +08:00
Coelacanthus
8f43334888
refactor: always use \n for newline and make fuart unbuffered (#201)
* refactor: revert println refactor

This reverts commit ae3a87803c.
This reverts commit 37ec17eeab.

* fix(apdu/at): make fuart unbuffered

related #167

Signed-off-by: Coelacanthus <uwu@coelacanthus.name>

* refactor: always use \n for newline

> C89 Standard section 5.2.2 Character display semantics
> \n (new line) Moves the active position to the initial position of the next line.

'\n' in C have including meaning of both '\r' and '\n' on Windows, and
libc SHALL translate them when do input and output. If not, it SHALL be
a bug of libc.

FYI, all mingw64 toolchain code use '\n' directly, so it's impossible to
be caused by '\n', otherwise mingw64 itself will broken. Mingw64 also
set _fmode to _O_TEXT by default.[1] So as MSVC documents said[2], it
should do translate between LF and CRLF.

[1]: https://github.com/mingw-w64/mingw-w64/blob/master/mingw-w64-crt/crt/txtmode.c
[2]: https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/fopen-wfopen

Signed-off-by: Coelacanthus <uwu@coelacanthus.name>

---------

Signed-off-by: Coelacanthus <uwu@coelacanthus.name>
2025-03-03 06:19:32 +08:00
901bff8c6c
chore: libqmi-glib minimum version constraint (#204) 2025-03-03 06:19:20 +08:00
24b7078a56
chore: improve pcsc_stringify_error for win32 (#202) 2025-03-02 21:52:00 +08:00
37ec17eeab
chore: improve println (#200) 2025-02-27 02:52:53 +08:00
7290736c73
feat: pcsc_stringify_error for win32 (#199) 2025-02-27 02:36:06 +08:00
26bde74517
fix: activation code parsing (#197)
* fix: activation code parsing

* fix: add strsep polyfill

* revert: variable name
2025-02-23 15:43:56 +08:00
9760a16b63
feat: improve isd-r aid handling (#193)
* chore: improve isd-r aid handling

* fix: type

* chore: provide more error message

* chore: accept reviews
2025-02-23 15:43:23 +08:00
e5297f304d
feat: customize mss (#192)
* feat: customize mss

* docs: add description

* chore: rename envvar

* chore: provide more error message

* fix: euicc_init

* fix: euicc_init

* revert: euicc_init

* chore: accept reviews
2025-02-23 15:42:50 +08:00
ae3a87803c
chore: unified println output for command line utility (#196)
* chore: unified println output for command line utility

* chore: unified println output for command line utility
2025-02-23 15:41:53 +08:00
3423b0939c
fix: define type (__MINGW32__ -> _WIN32) (#195) 2025-02-22 20:24:11 +08:00
1d18766142
fix: env-vars typo error (#194) 2025-02-22 16:11:31 +08:00
90f7104847
feat: human readable error code (pcsclite only) (#189) 2025-02-14 20:08:21 +08:00
Damon To
3d173b94b2
ci: add support for Linux ARM and Debian ARM builds in GitHub Actions (#190)
* ci: add support for Linux ARM and Debian ARM builds in GitHub Actions

* ci: update GitHub Actions workflow to include ARM builds for Linux and Debian
2025-02-11 20:47:30 +08:00
Root-Core
0b81e8ab14
euicc: added support for custom AIDs (#181)
- Added env variable "LPAC_CUSTOM_ISD_R_AID" for user defined AIDs
- Added documentation for new env var
2025-01-05 09:36:44 +08:00
Daniel Gimpelevich
62eb766d14
Update LINUX-DIST.md with debianization link (#150)
* Update LINUX-DIST.md with debianization link

* Update LINUX-DIST.md
2024-12-15 10:57:04 +08:00
Coelacanthus
b21406da8c
fix: only apply --export-all-symbol on Windows (#176)
It's meaningless for other platforms. And ld.gold doesn't support so if
LTO was enabled we will get invalid arguments.

address #152

Signed-off-by: Coelacanthus <uwu@coelacanthus.name>
2024-12-15 10:56:02 +08:00
da3d2a8e7a
chore: fixed github actions system (#178) 2024-12-15 10:09:05 +08:00
Coelacanthus
0fa28bb172
chore: enable LTO by default and add w/o LTO CI for debug (#177)
* chore: enable LTO by default and add w/o LTO CI for debug

* Better performance, small size, in theory.
* Cover more test points.

Signed-off-by: Coelacanthus <uwu@coelacanthus.name>

* fix: github action failed

---------

Signed-off-by: Coelacanthus <uwu@coelacanthus.name>
Co-authored-by: septs <github@septs.pw>
2024-12-15 10:03:50 +08:00
ShiinaSekiu
79034c665e
Export libeuicc all symbols (#152) 2024-12-06 11:07:55 +08:00
Frans Klaver
1f947173eb
ensure correct cmake script argument (#169)
When running a build in a scenario with multiple paths in
CMAKE_MODULE_PATH, we aren't actually running the git-version script.
This happens because we are APPENDing our own module path to the
existing setting.

Instead of relying on the contents of CMAKE_MODULE_PATH, create a
variable that is dedicated to our own location, and use that to specify
the git-version script.

Signed-off-by: Frans Klaver <frans.klaver@vislink.com>
Co-authored-by: Frans Klaver <frans.klaver@vislink.com>
2024-11-20 17:05:05 +08:00
Frans Klaver
5987dfa815
driver: apdu: add MBIM backend (#166)
Add an APDU backend for MBIM devices.

The MBIM device path can be passed via the MBIM_DEVICE environment
variable. We'll default to /dev/cdc-wdm0.

By default we will not operate through the mbim-proxy. Set
MBIM_USE_PROXY to 1 to enable this.

Like QMI devices, use UIM_PORT to select the active SIM slot.

Tested on Semtech EM9191 and EM7590, and Quectel RM520N-GL.

resolve #94

Signed-off-by: Frans Klaver <frans.klaver@vislink.com>
Co-authored-by: Frans Klaver <frans.klaver@vislink.com>
2024-11-16 22:43:29 +08:00
Coelacanthus
63f29b4c9f
driver/apdu/at: fix conditional compile (#165)
resolve #163

Signed-off-by: Celeste <CoelacanthusHex@gmail.com>
2024-11-06 17:23:45 +08:00
Luca Weiss
8d92e5a853
docs: document parameters for 'notification remove' (#162) 2024-10-20 18:37:55 +08:00
a5a0516f08
Expose es10x max segment size as an option in euicc_ctx (#160)
This is useful on mobile devices where larger MTU + faster baud rate can
result in 0x6601 checksum errors. This is going to be used in OpenEUICC
(lpac-jni) to set the mss lower for removable eUICCs.
2024-10-11 09:36:04 +08:00
Damon To
0dcc94905e
fix: initialize reason_buf_len in es10b_cancel_session_r (#154) 2024-09-09 11:09:45 +08:00
Damon To
9e0612b68d
fix: convert data type of ctx->aid (#148) 2024-08-27 21:09:07 +08:00
Coelacanthus
1304ca107e
refactor: optimize getopt() usage (#147)
* optind will be the index of the first mismatched argument, so use it
  directly.
* use while instead of for

Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
2024-08-21 01:47:24 +08:00
Coelacanthus
0499a3a977
fix: ensure "no conversion" result is checked correctly (#146)
Although POSIX said user should check errno instead of return value,
but errno may not be set when no conversion is performed according to C99.
Check nptr is same as str_end to ensure there is no conversion.

Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
2024-08-21 01:47:00 +08:00
Damon To
fd58ad7dc2
Bump 2.1.0 2024-08-19 18:57:54 +08:00
Damon To
319f55fe70
chore(docs): add interactive preview mode option 2024-08-18 22:35:39 +08:00
estkme
da1cf1a555 update download cancel process 2024-08-17 17:24:52 +08:00
estkme
cee7190751 workaround for es9p cancel session override error_detail 2024-08-17 15:17:53 +08:00
estkme
b11878fd0a typo 2024-08-17 15:14:37 +08:00
estkme
e6b32e106c Merge branch 'main' of github.com:estkme/lpac 2024-08-17 01:55:49 +08:00
estkme
302984f7d5 preview && cancel session 2024-08-17 01:55:04 +08:00
Luca Weiss
56352c51c8
docs: Add parameters for 'notification process' (#144)
Make sure it's visible in the usage documentation that these parameters
exist since they make life easier.

Fixes #127

Co-authored-by: Luca Weiss <luca.weiss@fairphone.com>
2024-08-16 16:36:27 +08:00
Damon To
19df5532f6
chore(driver): improve memory management in at driver (#140)
* chore(driver): improve memory management in at driver

* chore(driver): AT driver only supports linux

* chore: use malloc to allocate memory

* chore(driver): use macros instead of static variable

* fix: If memory allocation fails return -1
2024-08-02 12:43:04 +08:00
Damon To
c86edd5998
chore(driver): set pcsc and curl as default drivers. (#137) 2024-08-01 20:09:31 +08:00
Robert Marko
3bde4a1d3d
driver(APDU): add QMI backend (#131)
* driver: pass EUICC APDU or HTTP struct to driver fini OP

Currently, the .fini driver OP can only be used with global variables, but
that will be an issue when we cant use global variables.

This will be used with direct QMI in order to free the memory used by the
driver private structure instead of global variables.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* driver: apdu: rename QRTR QMI helpers to QMI helpers

Almost all of the QRTR QMI helpers will be reused for direct QMI so,
lets rename the sources to indicate that.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* driver: apdu: extract common QMI code

Support for using QMI directly and not over QRTR would use a lot of the
same code as QMI over QRTR, so in order to prevent code duplication lets
extract that common code so it can be reused.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* driver: apdu: qmi-helpers: allow compiling without libqrtr

Direct QMI backend wont use any of the libqmi QRTR functionality so it
wont depend on libqrtr and thus we need to make sure QMI helpers still
compile without libqrtr in the system.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* driver: apdu: dont use global variables for QMI

Since we split out the common QMI code then we cannot be using global
variables since existing QRTR and the coming QMI drivers will clash
by trying to use the same global variable names with the common code.

So, lets move to passing a structure which is driver specific instead.

Since we are not using global variables anymore, we cannot be using atexit
anymore, so lets move that cleanup step to driver finish OP instead.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* driver: apdu: add QMI backend

Previously QMI over QRTR support was added, however that is only present in
modern Qualcomm modems and only when running in PCIe mode and its quite
common to still only use even the latest modems via USB.

In that case, they are all still controllable via QMI but it is directly
exposed as a character device in Linux so we can reuse most of the code
from QMI over QRTR support but drop the support for libqrtr to talk to
the modems.

We require the QMI device path to be passed via QMI_DEVICE env variable
for the backend to operate.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* docs: ENVVARS: document QMI backend

Document the new direct QMI backend ENV variables as well as make it
clear that UIM_SLOT is not a QMI QRTR only variable.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

* driver: apdu: qmi-helpers: support opening QMI device in proxy mode

Currently, we are using QMI_DEVICE_OPEN_FLAGS_NONE to open the QMI device
and thus we are requesting exclusive access to the device while we need
to talk to it.

This will work fine as long as we are the only thing trying to use that
QMI device at the same time or the device was not already opened in proxy
mode.

This is an issue since ModemManager will open the device in proxy mode so
that qmicli or other applications can still talk to the same QMI device
but it will break lpac from trying to use QMI.

So, lets try and open the device in proxy mode, libqmi will the start the
qmi-proxy service automatically as its built and installed as part of it.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>

---------

Signed-off-by: Robert Marko <robert.marko@sartura.hr>
2024-07-24 15:59:37 +08:00
Luca Weiss
0011ea6cc4
docs: add link to lpa-gtk ui for lpac (#125)
Written with GTK4 and Libadwaita it's targetting Linux Mobile
distributions such as postmarketOS or Mobian.

See also: https://lucaweiss.eu/post/2024-06-24-esim-manager-for-mobile-linux/

Co-authored-by: Luca Weiss <luca.weiss@fairphone.com>
2024-06-24 19:39:21 +08:00
d508b28beb
refactor: bash scripts (#123) 2024-06-24 09:28:41 +08:00
f5956dd6d5
chore: move rlpa-server to independent repo (#122) 2024-06-17 23:18:54 +08:00
Damon To
dace6558b8
Bump 2.0.2 2024-06-16 14:04:23 +08:00
FakeQueally
2cc0ba0e92
chore: disable fail-fast and better artifacts naming in action (#121) 2024-06-16 12:57:05 +08:00
6e295dbeaf
chore: refactor build script (#119)
* refactor: build script

* docs: update build guide for WoA

---------

Co-authored-by: FakeQueally <129683130+BeRealQueally@users.noreply.github.com>
2024-06-16 10:17:24 +08:00
BeRealQueally
b6362be60e docs: fix WoA build script
[skip ci]
2024-06-16 00:55:17 +08:00
BeRealQueally
f43c70c293 docs: improve developer docs 2024-06-16 00:43:44 +08:00
BeRealQueally
c7a2f5d6c3 chore: fix action scripts 2024-06-16 00:16:45 +08:00
Andy Schroder
979ccc8e8f
chore: improve build script for debian (#110)
* standardize .deb package output file name

* add zip dependency in setup-debian.sh for build.sh
2024-06-15 22:22:41 +08:00
75cbfa16ce
docs: add aur hint (#117) 2024-06-14 21:14:27 +08:00
09756a834b
docs: add linux dist (#116)
* docs: add linux dist

* docs: add caution section

* docs: accept review

* docs: update openwrt available version

* docs: improve installation command hinting
2024-06-14 17:47:11 +08:00
estkme
e7445eea41 Merge branch 'main' of github.com:estkme/lpac into main 2024-06-14 00:27:51 +08:00
8294307f8f
docs: fix typo (#115) 2024-06-12 18:57:24 +08:00
estkme
176cca4b6b update es10b_getrat 2024-06-04 15:14:33 +08:00
Coelacanthus
380b91325c
chore(cpack): fix libc name on Debian (#107)
They use libc6 rather than libc.
2024-05-30 13:02:54 +08:00
ShiinaSekiu
9690320fea
Fix incorrect variable name in documentation (#103) 2024-05-30 09:30:32 +08:00
Damon To
d41c2f8446
chore(docs): add new environment variables 2024-05-27 10:03:21 +08:00
Damon To
49bf6a5df5
chore: remove unnecessary spaces 2024-05-25 00:01:14 +08:00
Luca Weiss
66c45959c3
driver: qmi_qrtr: Allow selecting SIM slot using environment variable (#97)
Introduce the UIM_SLOT variable which can be set to the SIM slot you
want to manage. Commonly '1' and '2' are available for dual SIM devices,
though nothing should be preventing it from potential 3-or-more SIM slot
devices.

Co-authored-by: Luca Weiss <luca.weiss@fairphone.com>
2024-05-24 23:49:37 +08:00
estkme
25506d5d64 For windows 32... 2024-05-24 19:35:04 +08:00
Luca Weiss
c3758fca7f
Add QMI-over-QRTR APDU backend for running on Qualcomm SoCs (#70)
On modern smartphones the communication happens using the QMI protocol
via the QRTR transport to communicate with the modem.

Add support for such devices by wrapping libqrtr-glib and libqmi-glib
and using those APIs to provide an APDU backend for lpac.

Co-authored-by: Luca Weiss <luca.weiss@fairphone.com>
Co-authored-by: estkme <145633413+estkme@users.noreply.github.com>
2024-05-19 13:04:47 +08:00
David Bauer
c4ce98c527
profile: fix error message for delete function (#95)
This was incorrectly identified as the disable function.

Signed-off-by: David Bauer <mail@david-bauer.net>
2024-05-15 22:11:54 +08:00
ShiinaSekiu
14e07fa9b4
Add license to artifacts and src (#93)
Add license to artifacts and src
2024-05-13 10:16:26 +08:00
estkme
1e299ef51e Merge branch 'main' of github.com:estkme/lpac 2024-05-11 11:02:57 +08:00
estkme
57e5e31ce9 [Not-Tested] Fix for 18-digit iccid 2024-05-11 11:02:04 +08:00
06cbc3778c
fix: typo (#90) 2024-05-11 08:02:03 +08:00
f521c455dc
chore: add editorconfig (#89) 2024-05-10 12:27:23 +08:00
estkme
e19e5ee3f9 update 2024-05-10 12:25:16 +08:00
db5dc14fb6
feat: batch handling notification {process,remove} (#82) 2024-05-09 21:51:10 +08:00
estkme
c8c3c4fdb7 update 2024-05-09 21:38:20 +08:00
08ba0c280e
feat: es9p error message fallback (#86)
* feat: es9p error message fallback

* chore: update description

* chore: simplify es9p_error_message

* chore: simplify include
2024-05-09 21:26:04 +08:00
4cbadb5d5d
docs: upgrade ASN.1 definitions to SGP.22 v2.2.2 (#87) 2024-05-09 19:42:52 +08:00
estkme
c632f86b22 [Not-Tested] es10b/9p cancel session 2024-05-09 15:10:59 +08:00
estkme
2eb3e45e0b add es9p_base64_trim for some dp+ return \n in base64 message 2024-05-09 13:47:07 +08:00
3a32229c1c
fix: typo (#85) 2024-05-09 09:49:36 +08:00
baee77210f
docs: add more 3rd-party based on lpac program (#84) 2024-05-08 17:04:24 +08:00
Coelacanthus
5b98993af4
chore: rename documents directory to docs (#83)
Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>
2024-05-08 15:01:50 +08:00
Coelacanthus
8ca9e1d3de
chore: declare standard version supported by lpac (#81)
* chore: declare standard version supported by lpac

Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>

* chore: add link to SGP.22 v2.2.2

Co-authored-by: septs <github@septs.pw>

---------

Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>
Co-authored-by: septs <github@septs.pw>
2024-05-08 14:45:31 +08:00
Coelacanthus
c52258d6be
fix: use CMAKE_INSTALL_FULL_* to get absolute path (#80)
Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>
2024-05-08 12:01:05 +08:00
2c805916dc
feat: add detail to progress event (#78) 2024-05-08 11:30:15 +08:00
Coelacanthus
6e468944cf
chore: split document to multi-parts and document environment variables (#79)
* chore: split document to multi-parts

Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>

* chore: add document for enviornment variables used by lpac

Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>

* chore: add debug section in developers document

Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>

---------

Signed-off-by: Coelacanthus <CoelacanthusHex@gmail.com>
2024-05-08 11:28:14 +08:00
ee4b208186
feat: add profile download activation code parsing (#72)
* feat: add profile download activation code parsing

* docs: update example

* chore: simplify strtok operations
2024-05-05 20:56:52 +08:00
ShiinaSekiu
e3bae10048
Fix Unicode characters not handled correctly on Windows platform (#74)
* Fix Unicode characters not handled correctly on Windows platform

* Fix build error
2024-05-05 20:55:42 +08:00
Damon To
d85537a909
Bump 2.0.1 2024-04-26 15:16:22 +08:00
603883b794
chore: remove warning on macOS build (#68) 2024-04-20 21:25:32 +08:00
ac1d343006
docs: improve readme file (#67) 2024-04-20 21:25:10 +08:00
faef813b17
fix: chip info bus error (#66) 2024-04-19 23:49:51 +08:00
estkme
c33781300b update 2024-04-19 11:58:50 +08:00
c90607b225
[Not Tested] feat: add ES10b#GetRAT Support (#63)
* feat: add ES10b#GetRAT Support

* chore: add free

* chore: rename mcc-mnc to plmn
2024-04-19 10:59:17 +08:00
Damon To
459bb15a99
chore: change macos-14 to macos-latest 2024-04-02 10:04:16 +08:00
79 changed files with 4558 additions and 1631 deletions

12
.editorconfig Normal file
View file

@ -0,0 +1,12 @@
root = true
[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
indent_size = 2

View file

@ -1,4 +1,4 @@
name: Release name: Build
on: on:
workflow_dispatch: workflow_dispatch:
@ -11,34 +11,45 @@ on:
jobs: jobs:
build: build:
name: Build for ${{ matrix.build.name }} name: Build for ${{ matrix.build.name }}
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.build.os }}
strategy: strategy:
fail-fast: false
matrix: matrix:
os: [ubuntu-latest]
build: build:
- {variant: make, name: Linux, artifact: linux-x64} - {os: ubuntu-24.04, variant: make, name: Linux, artifact: linux-x64}
- {variant: debian, name: Debian, artifact: debian-x64} - {os: ubuntu-24.04-arm, variant: make, name: Linux ARM, artifact: linux-arm}
- {variant: mingw, name: Windows with MinGW, artifact: windows-x64} - {os: ubuntu-24.04, variant: make-without-lto, name: Linux (w/o LTO), artifact: linux-x64-without-lto}
- {variant: woa-mingw, name: Windows on ARM with MinGW, artifact: windows-arm64} - {os: ubuntu-24.04-arm, variant: make-without-lto, name: Linux ARM (w/o LTO), artifact: linux-arm-without-lto}
include: - {os: ubuntu-24.04, variant: debian, name: Debian, artifact: debian-x64}
- os: macos-14 - {os: ubuntu-24.04-arm, variant: debian, name: Debian ARM, artifact: debian-arm}
build: {variant: make, name: macOS, artifact: macos-universal} - {os: ubuntu-24.04, variant: mingw, name: Windows with MinGW, artifact: windows-x64}
- {os: ubuntu-24.04, variant: woa-mingw, name: Windows on ARM with MinGW, artifact: windows-arm64}
- {os: macos-15, variant: make, name: macOS, artifact: macos-universal}
- {os: macos-15, variant: make-without-lto, name: macOS (w/o LTO), artifact: macos-universal-without-lto}
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup Toolchain - name: Setup Toolchain
run: ./scripts/setup-debian.sh run: sudo ./scripts/setup-debian.sh ${{ matrix.build.variant }}
if: runner.os == 'Linux' if: runner.os == 'Linux'
- name: Build for ${{ matrix.build.name }} - name: Build for ${{ matrix.build.name }}
run: ./scripts/build.sh ${{ matrix.build.variant }} run: ./scripts/build-ci.sh ${{ matrix.build.variant }}
- name: Get short SHA
run: echo "SHA7=$(echo ${GITHUB_SHA} | cut -c1-7)" >> $GITHUB_ENV
- name: Upload ${{ matrix.build.name }} to Artifact - name: Upload ${{ matrix.build.name }} to Artifact
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
with: with:
name: ${{ matrix.build.artifact }} name: lpac-${{ env.SHA7 }}-${{ matrix.build.artifact }}
path: lpac-*.* path: ${{ github.workspace }}/build/*.*
release: release:
name: Release name: Release
runs-on: ubuntu-latest runs-on: ubuntu-24.04
if: startsWith(github.ref, 'refs/tags/v') if: startsWith(github.ref, 'refs/tags/v')
needs: build needs: build
permissions: permissions:

3
.gitignore vendored
View file

@ -9,7 +9,6 @@ install_manifest.txt
compile_commands.json compile_commands.json
CTestTestfile.cmake CTestTestfile.cmake
_deps _deps
build
.vscode* .vscode*
.DS_Store .DS_Store
@ -17,7 +16,7 @@ build
/src/version.h /src/version.h
# for package files # for package files
lpac-*.deb lpac_*.deb
lpac-*.zip lpac-*.zip
# for clion ignores # for clion ignores

View file

@ -1,15 +1,36 @@
cmake_minimum_required (VERSION 3.8) cmake_minimum_required (VERSION 3.15)
project (lpac project (lpac
VERSION 2.0.0 VERSION 2.1.0
HOMEPAGE_URL "https://github.com/estkme-group/lpac" HOMEPAGE_URL "https://github.com/estkme-group/lpac"
DESCRIPTION "C-based eUICC LPA." DESCRIPTION "C-based eUICC LPA."
LANGUAGES C) LANGUAGES C)
set(CMAKE_C_STANDARD 99)
set(CMAKE_C_STANDARD_REQUIRED ON)
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") set(LPAC_CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
list(APPEND CMAKE_MODULE_PATH ${LPAC_CMAKE_MODULE_PATH})
if(NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)
# Git auto-ignore out-of-source build directory
file(GENERATE OUTPUT .gitignore CONTENT "*")
endif()
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
# add_compile_options(-Wall -Wextra -Wpedantic) # add_compile_options(-Wall -Wextra -Wpedantic)
# Enable LTO when possible.
include(CheckIPOSupported)
check_ipo_supported(RESULT result OUTPUT output)
if(result)
if(NOT DEFINED CMAKE_INTERPROCEDURAL_OPTIMIZATION)
set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
endif()
else()
message(INFO "IPO is not supported: ${output}")
endif()
if (APPLE) if (APPLE)
set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64") set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64")
endif() endif()
@ -17,7 +38,7 @@ endif()
if(UNIX) if(UNIX)
include(GNUInstallDirs) include(GNUInstallDirs)
if(NOT CMAKE_INSTALL_RPATH) if(NOT CMAKE_INSTALL_RPATH)
set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_LIBDIR}/lpac") set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_FULL_LIBDIR}/lpac")
endif() endif()
endif() endif()
@ -30,11 +51,13 @@ endif()
if(CPACK_GENERATOR) if(CPACK_GENERATOR)
set(CPACK_PACKAGE_VENDOR "eSTK.me Group") set(CPACK_PACKAGE_VENDOR "eSTK.me Group")
set(CPACK_DEBIAN_PACKAGE_MAINTAINER "eSTK.me Group") set(CPACK_DEBIAN_PACKAGE_MAINTAINER "eSTK.me Group")
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc") set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6")
set(CPACK_DEBIAN_PACKAGE_RECOMMENDS "libcurl, libpcsclite, pcscd") set(CPACK_DEBIAN_PACKAGE_RECOMMENDS "libcurl, libpcsclite, pcscd")
set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
set(CPACK_RPM_PACKAGE_LICENSE "AGPL-3.0-only AND LGPL-2.0-only") set(CPACK_RPM_PACKAGE_LICENSE "AGPL-3.0-only AND LGPL-2.0-only")
set(CPACK_RPM_PACKAGE_AUTOREQ "yes") set(CPACK_RPM_PACKAGE_AUTOREQ "yes")
set(CPACK_RPM_PACKAGE_REQUIRES "libcurl, libpcsclite, pcscd") set(CPACK_RPM_PACKAGE_REQUIRES "libcurl, libpcsclite, pcscd")

492
README.md
View file

@ -1,493 +1,51 @@
# lpac # lpac
lpac is a cross platform local profile agent program. lpac is a cross-platform local profile agent program, compatible with [SGP.22 version 2.2.2](https://www.gsma.com/solutions-and-impact/technologies/esim/wp-content/uploads/2020/06/SGP.22-v2.2.2.pdf).
Features: Features:
- Support Activate Code and Confirm Code - Support Activation Code and Confirmation Code
- Support custom IMEI sent to server - Support Custom IMEI sent to server
- Support Profile Discovery (SM-DS) - Support Profile Discovery (SM-DS)
- Profile management: list, enable, disable, delete and nickname - Profile management: list, enable, disable, delete and nickname
- Notification management: list, send and delete - Notification management: list, send and delete
- Lookup eUICC chip info - Lookup eUICC chip info
- etc - etc
Download:
[Github Release](https://github.com/estkme-group/lpac/releases/latest)
lpac is dynamic-linked, Release is built by Github action, if you can't run it you need to compile by yourself
## GUI Frontend
- [EasyLPAC](https://github.com/creamlike1024/EasyLPAC)
- [{Open,Easy}EUICC](https://gitea.angry.im/PeterCxy/OpenEUICC) ([Mirror](https://github.com/estkme-group/openeuicc))
## Compile
<details>
<summary>Linux</summary>
- Debian/Ubuntu
```bash
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
./scripts/build.sh make
```
then execute `./output/lpac` to use.
- Droidian
Same as normal Debian/Ubuntu, however, in order to build the GBinder backends, you will need `libgbinder-dev`, `glib2.0-dev`, and you will have to set `-DLPAC_WITH_APDU_GBINDER=ON` when invoking `cmake`.
</details>
<details>
<summary>macOS</summary>
- Install [Homebrew](https://brew.sh/).
```bash
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac
./scripts/build.sh make
```
</details>
<details>
<summary>Windows(x86_64)</summary>
Windows need prebuilt libcurl.dll, you can replace the download link to newest curl version.
- Build on Linux(MINGW)
```bash
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
./scripts/build.sh mingw
```
- Build on Windows(MSYS2)
```bash
pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-gcc
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac
./scripts/build.sh mingw
```
- Build on Windows(Cygwin)
With `gcc-core` `gcc-g++` `make` `cmake` `unzip` `wget` installed
```bash
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac
./scripts/build.sh mingw
```
To run it outside Cygwin shell, you need copy `cygwin1.dll` to the program folder to distribute.
`cygwin1.dll` is located in `C:\cygwin64\bin\cygwin1.dll` (Default Cygwin installation location)
</details>
<details>
<summary>Windows on ARM</summary>
- Cross compile on Windows/Linux host(arm64,x86_64 and more architecture) with zig
Install [zig](https://ziglang.org/download/)
```bash
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac
./scripts/build.sh woa-zig
```
- Cross compile on Linux x86_64 host(GNU toolchain)
```bash
git clone --depth=1 https://github.com/estkme-group/lpac
cd lpac
./scripts/build.sh woa-mingw
```
- Build on Windows(MSYS2)
It is possible to build on **WoA devices** with [MSYS2 ARM64 Support](https://www.msys2.org/wiki/arm64/)
You may need to install `mingw-w64-clang-aarch64-cmake`, `mingw-w64-clang-aarch64-clang` and modify `cmake/linux-mingw64.cmake`(replace toolchain).
Download prebuilt curl dll is also needed. Refer to the previous compilation steps.
</details>
## Usage ## Usage
In Linux, you need install `pcscd`, `pcsclite` and `libcurl`. You can download lpac from [GitHub Release][latest], and read [USAGE](docs/USAGE.md) to use it.
If you can't run it you need to compile by yourself, see also [DEVELOPERS](docs/DEVELOPERS.md).
If you want to known which Linux distributions include lpac, see also [LINUX-DIST](docs/LINUX-DIST.md).
If you have any issue, please read [FAQ](docs/FAQ.md) first.
APDU and HTTP interfaces of lpac has serval backends, you need specify `$LPAC_APDU` and `$LPAC_HTTP` environment variable to interface library path. If not specified, it will use `pcsc` and `curl`. [latest]: https://github.com/estkme-group/lpac/releases/latest
APDU Backends: ## Software Ecosystem
- `at`: use AT commands interface used by LTE module - [EasyLPAC] (Windows, Linux and macOS)
- `pcsc`: use PC/SC Smart Card API - [{Open,Easy}EUICC][openeuicc] ([Mirror][openeuicc-mirror], Android)
- `stdio`: use standard input/output - [eSIM Manager (lpa-gtk)](https://codeberg.org/lucaweiss/lpa-gtk) (Linux Mobile)
- GBinder-based backends for `libhybris` (Halium) distributions: - [rlpa-server](https://github.com/estkme-group/rlpa-server) for eSTK.me Cloud Enhance function
- `gbinder_hidl`: use HIDL IRadio (SoC launched before Android 13)
Using `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. [easylpac]: https://github.com/creamlike1024/EasyLPAC/releases/latest
[openeuicc]: https://gitea.angry.im/PeterCxy/OpenEUICC
HTTP Backends: [openeuicc-mirror]: https://github.com/estkme-group/openeuicc
- `curl`: use libcurl
- `stdio`: use standard input/ouput
## CLI
### Command format
```plain
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 libXXXXinterface info
subcommand 2:
Please refer to the detailed instructions below
```
### Return value
The return contents of lpac instructions are all in json format, and the returns of all instructions comply with the following format.
```jsonc
{
"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.
### Subcommand
#### chip
View the EID, default SM-DP+ server and SM-DS server of eUICC. euicc_info2 is also supported.
```plain
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!
```
<details>
<summary>Return value example</summary>
```json
{
"type": "lpa",
"payload": {
"code": 0,
"message": "success",
"data": {
"eidValue": "[EID]",
"EuiccConfiguredAddresses": {
"defaultDpAddress": null,
"rootDsAddress": "testrootsmds.gsma.com"
},
"EUICCInfo2": {
"profileVersion": "2.1.0",
"svn": "2.2.0",
"euiccFirmwareVer": "4.6.0",
"extCardResource": {
"installedApplication": 0,
"freeNonVolatileMemory": 291666,
"freeVolatileMemory": 5970
},
"uiccCapability": [
"usimSupport",
"isimSupport",
"csimSupport",
"akaMilenage",
"akaCave",
"akaTuak128",
"akaTuak256",
"gbaAuthenUsim",
"gbaAuthenISim",
"eapClient",
"javacard",
"multipleUsimSupport",
"multipleIsimSupport"
],
"ts102241Version": "9.2.0",
"globalplatformVersion": "2.3.0",
"rspCapability": [
"additionalProfile",
"testProfileSupport"
],
"euiccCiPKIdListForVerification": [
"81370f5125d0b1d408d4c3b232e6d25e795bebfb"
],
"euiccCiPKIdListForSigning": [
"81370f5125d0b1d408d4c3b232e6d25e795bebfb"
],
"euiccCategory": null,
"forbiddenProfilePolicyRules": [
"pprUpdateControl",
"ppr1"
],
"ppVersion": "0.0.1",
"sasAcreditationNumber": "GI-BA-UP-0419",
"certificationDataObject": {
"platformLabel": "1.2.840.1234567/myPlatformLabel",
"discoveryBaseURL": "https://mycompany.com/myDLOARegistrar"
}
}
}
}
}
```
\* Starting from SGP.22 v2.1, `javacardVersion` is renamed to `ts102241Version` \
\*\* SGP.22 has been a typo, `sasAcreditationNumber` should be `sasAccreditationNumber`
</details>
#### profile
Profile management, you can list, set alias (nickname), enable, disable, delete, download and discovery Profiles.
```plain
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 Download profile from SM-DP server
discovery Detect available profile registered on SM-DS server
```
> [!NOTE]
> Some eUICC chip have trouble when enable profile (e.g. These removeable eUICC cards from ECP), try AID, ICCID, refreshFlag with 1 or 0 to find out the working way for these chips.
There is no secondary confirmation for deleting a Profile, so please perform it with caution.
> [!NOTE]
> This function will only delete the Profile and issue a Notification, but it will not be sent automatically. You need to send it manually.
##### Download requires connection to SM-DP+ server and the following additional parameters:
- `-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.
<details>
<summary>Example</summary>
```bash
./lpac profile download -s rsp.truphone.com -m "QR-G-5C-1LS-1W1Z9P7"
```
</details>
##### Discovery requires connecting to the SM-DS server to query registered profile
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
<details>
<summary>Return value example of lpac profile list</summary>
```json
{
"type": "lpa",
"payload": {
"code": 0,
"message": "success",
"data": [
{
"iccid": "89353...",
"isdpAid": "A0000005591010FFFFFFFF8900001000",
"profileState": "disabled",
"profileNickname": null,
"serviceProviderName": "Vodafone IE",
"profileName": "Vodafone IE eSIM",
"iconType": "png",
"icon": "iVBO...",
"profileClass": "operational"
},
{
"iccid": "89012...",
"isdpAid": "A0000005591010FFFFFFFF8900001100",
"profileState": "disabled",
"profileNickname": null,
"serviceProviderName": "T-Mobile",
"profileName": "CONVSIM5G_Adaptive",
"iconType": "png",
"icon": "iVBO...",
"profileClass": "operational"
},
{
"iccid": "89444...",
"isdpAid": "A0000005591010FFFFFFFF8900001200",
"profileState": "enabled",
"profileNickname": null,
"serviceProviderName": "BetterRoaming",
"profileName": "BetterRoaming",
"iconType": "none",
"icon": null,
"profileClass": "operational"
},
{
"iccid": "89852...",
"isdpAid": "A0000005591010FFFFFFFF8900001300",
"profileState": "disabled",
"profileNickname": null,
"serviceProviderName": "Redtea Mobile",
"profileName": "RedteaGO",
"iconType": "none",
"icon": null,
"profileClass": "operational"
}
]
}
}
```
- `iccid`: ICCID of Profile
- `isdpAid`: Aid of Profile
- `profileState`: State of Profile, "Enabled" or "Disabled"
- `profileNickname`: Nickname of Profile
- `serviceProviderName`: Telecom operators of Profile
- `profileName`: Name of Profile
- `iconType`: Profile icon data struct, "none", "png", "jpg"
- `icon`: Profile icon data in base64
- `profileClass`: Type of Profile
</details>
#### notification
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.
```plain
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>
```
> [!NOTE]
> Downstream developers or end users should process Notification as soon as possible when they exist to comply with GSMA specifications. lpac will not automatically delete the Notification after sending it, and you need to delete it manually.
<details>
<summary>Return value example of lpac notification list</summary>
```json
{
"type": "lpa",
"payload": {
"code": 0,
"message": "success",
"data": [
{
"seqNumber": 178,
"profileManagementOperation": "install",
"notificationAddress": "rsp-eu.redteamobile.com",
"iccid": "89852..."
},
{
"seqNumber": 215,
"profileManagementOperation": "disable",
"notificationAddress": "cust-005-v4-prod-atl2.gdsb.net",
"iccid": "89012..."
},
{
"seqNumber": 216,
"profileManagementOperation": "enable",
"notificationAddress": "rsp.truphone.com",
"iccid": "89444..."
}
]
}
}
```
- `seqNumber`: Sequence ID
- `profileManagementOperation`: Which operation generated this notification
- `notificationAddress`: Profile's notification reporting server address
</details>
#### driver
Now there is only one command: `lpac driver apdu list` to get card reader list.
## FAQ
<details>
<summary>Q: Any subcommand of lpac will get error message like "SCardListReaders() failed:" and 8-digits error code, such as 80100069, 80100066, 8010002E, 8010000F and so on.</summary>
A:
- 80100069 means your UICC is not plugged correctly
- 80100066 means your card has no response, please clean the pin and plug in again
- 8010002E means communication error
- 8010000F means the card is not a eUICC, or detect wrong card reader like Yubikey. For latter one, you can use `lpac driver apdu list` to list all reader and use `$DRIVER_IFID` to specify correct card reader
- for others, Google is your friend.
</details>
<details>
<summary>Q: I can't download eSIM profile of xxx.</summary>
A: The verification of SM-DP+ servers of telecom operators is diverse. Please check whether the parameters you enter are consistent with those provided to you by the telecom operators. Some telecom operators issue profiles in the form of push, which may require the use of lpac's discovery and custom IMEI function.
</details>
## Thanks ## Thanks
<a href="https://github.com/estkme-group/lpac/graphs/contributors"> [![Contributors][contrib]][contributors]
<img src="https://contrib.rocks/image?repo=estkme-group/lpac" alt="" />
</a> [contrib]: https://contrib.rocks/image?repo=estkme-group/lpac
[contributors]: https://github.com/estkme-group/lpac/graphs/contributors
--- ---
## License ## License
- lpac (/src, /driver): AGPL-3.0 - lpac ([/src](src), [/driver](driver)): AGPL-v3.0-only
- libeuicc (/euicc): LGPL-v2 - libeuicc ([/euicc](euicc)): LGPL-v2.1-only or Commercial License Agreement with ESTKME TECHNOLOGY LIMITED, Hong Kong
- cjson ([/cjson](cjson)): MIT
- dlfcn-win32 ([/dlfcn-win32](dlfcn-win32)): MIT
Copyright (c) 2023-2024 eSTKme Group Copyright &copy; 2023-2025 ESTKME TECHNOLOGY LIMITED, Hong Kong

View file

@ -1,3 +0,0 @@
asn1c -fwide-types -fcompound-names -fincludes-quoted -no-gen-example ../../../asn1/PKIXExplicit88.asn ../../../asn1/PKIXImplicit88.asn ../../../asn1/rsp.asn
find "." -type f \( -name "*.c" -o -name "*.h" \) | while read -r file; do for header in $(find "." -type f -name "*.h"); do header_file=$(basename "$header"); sed -i "/#include <${header_file}>/c\#include \"${header_file}\"" "$file"; done; done

19
cjson/LICENSE Normal file
View file

@ -0,0 +1,19 @@
Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

15
cmake/linux-mingw32.cmake Normal file
View file

@ -0,0 +1,15 @@
set(CMAKE_SYSTEM_NAME Windows)
set(TOOLCHAIN_PREFIX i686-w64-mingw32)
set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-gcc)
set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-g++)
set(CMAKE_Fortran_COMPILER ${TOOLCHAIN_PREFIX}-gfortran)
set(CMAKE_RC_COMPILER ${TOOLCHAIN_PREFIX}-windres)
set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX})
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

17
dlfcn-win32/LICENSE Normal file
View file

@ -0,0 +1,17 @@
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

View file

@ -758,7 +758,7 @@ static BOOL is_import_thunk( const void *addr )
#endif #endif
} }
/* Return adress from the import address table (iat), /* Return address from the import address table (iat),
* if the original address points to a thunk table entry. * if the original address points to a thunk table entry.
*/ */
static void *get_address_from_import_address_table( void *iat, DWORD iat_size, const void *addr ) static void *get_address_from_import_address_table( void *iat, DWORD iat_size, const void *addr )

90
docs/DEVELOPERS.md Normal file
View file

@ -0,0 +1,90 @@
# Developer Manual
## Coding Standard
lpac is written with C99 and compatible with [SGP.22 version 2.2.2](https://www.gsma.com/solutions-and-impact/technologies/esim/wp-content/uploads/2020/06/SGP.22-v2.2.2.pdf).
## How to Compile
### Linux
#### Debian/Ubuntu
``` bash
# clone this repo in the top-level folder
# install dependencies
./scripts/setup-debian.sh
```
Run `cmake` and `make`, compiled output will be in `output` directory.
If you want to get a Deb package, run `cmake -DCPACK_GENERATOR=DEB` then `make`.
#### Droidian
Same as normal Debian/Ubuntu, however, in order to build the GBinder backends, you will need `libgbinder-dev`, `glib2.0-dev`, and you will have to pass `-DLPAC_WITH_APDU_GBINDER=ON` when invoking `cmake`.
---
### macOS
Install [Homebrew](https://brew.sh/).
Run `cmake` and `make`, compiled output will be in `output` directory.
---
### Windows(x86_64)
Windows need libcurl.dll to run.
Download libcurl from <https://curl.se/download.html> and place it as `libcurl.dll` in `output` directory.
Install prerequisites, run `cmake` and `make`, compiled output will be in `output` directory.
#### Build on Linux(MINGW)
Require `build-essential` `cmake` `git` `g++` `libpcsclite-dev` `libcurl4-openssl-dev` `gcc-mingw-w64` `g++-mingw-w64` installed.
#### Build on Windows(MSYS2)
Require `mingw-w64-x86_64-cmake` `mingw-w64-x86_64-gcc` installed.
#### Build on Windows(Cygwin)
Require `gcc-core` `gcc-g++` `make` `cmake` `unzip` `wget` installed.
To run it outside Cygwin shell, you need copy `cygwin1.dll` to the program folder to distribute.
`cygwin1.dll` is located in `C:\cygwin64\bin\cygwin1.dll` (Default Cygwin installation location)
---
### Windows on ARM
#### Cross compile on Windows/Linux host(arm64,x86_64 and more architecture) with zig
Install [zig](https://ziglang.org/download/)
```bash
# clone this repo in the top-level folder
./scripts/build-woa.sh zig
```
#### Cross compile on Linux x86_64 host(GNU toolchain)
```bash
# clone this repo in the top-level folder
./scripts/build-woa.sh mingw
```
#### Build on Native Windows on ARM(MSYS2)
It is possible to build on **WoA devices** with [MSYS2 ARM64 Support](https://www.msys2.org/wiki/arm64/)
You may need to install `mingw-w64-clang-aarch64-cmake`, `mingw-w64-clang-aarch64-clang` and modify `cmake/linux-mingw64.cmake`(replace toolchain).
Download prebuilt curl dll is also needed. Refer to the previous compilation steps.
## Debug
Please see [debug environment variables](ENVVARS.md#debug)

31
docs/ENVVARS.md Normal file
View file

@ -0,0 +1,31 @@
# Environment Variables
## General
* `LPAC_CUSTOM_ES10X_MSS`: specify maximum segment size for ES10x APDU backend. (default: 120, min: 6, max: 255)
* `LPAC_CUSTOM_ISD_R_AID`: specify which AID will be used to open the logic channel. (hex string, 32 chars)
* `LPAC_APDU`: specify which APDU backend will be used. Values:
- `at`: use AT commands interface used by LTE module
- `pcsc`: use PC/SC Smart Card API
- `stdio`: use standard input/output
- `qmi`: use QMI
- `qmi_qrtr`: use QMI over QRTR
- `mbim`: use MBIM
- GBinder-based backends for `libhybris` (Halium) distributions:
- `gbinder_hidl`: use HIDL IRadio (SoC launched before Android 13)
* `LPAC_HTTP`: specify which HTTP backend will be used.
- `curl`: use libcurl
- `stdio`: use standard input/output
* `AT_DEVICE`: specify which serial port device will be used by AT APDU backend.
* `QMI_DEVICE`: specify which QMI device will be used by QMI APDU backend.
* `UIM_SLOT`: specify which UIM slot will be used by QMI and MBIM APDU backends. (default: 1, slot number starts from 1)
* `DRIVER_IFID`: specify which PC/SC interface will be used by PC/SC APDU backend.
* `MBIM_DEVICE`: specify which MBIM device will be used by MBIM APDU backend. (default: `/dev/cdc-wdm0`)
* `MBIM_USE_PROXY`: tell the MBIM APDU backend to use the mbim-proxy. (default: 0, anything other than 0 means true)
## Debug
* `LIBEUICC_DEBUG_APDU`: enable debug output for APDU.
* `LIBEUICC_DEBUG_HTTP`: enable debug output for HTTP.
* `AT_DEBUG`: enable debug output for AT APDU backend.
* `GBINDER_APDU_DEBUG`: enable debug output for GBinder APDU backend. MUST be `true` to take effect.

18
docs/FAQ.md Normal file
View file

@ -0,0 +1,18 @@
## FAQ
### Any subcommand of lpac will get error message like "SCardListReaders() failed:" and 8-digits error code, such as 80100069, 80100066, 8010002E, 8010000F and so on.
- [80100069] means your UICC is not plugged correctly
- [80100066] means your card has no response, please clean the pin and plug in again
- [8010002E] means communication error
- [8010000F] means the card is not a eUICC, or detect wrong card reader like Yubikey. For latter one, you can use `lpac driver apdu list` to list all reader and use `$DRIVER_IFID` to specify correct card reader
- for others, Google is your friend.
[80100069]: https://pcsclite.apdu.fr/api/group__ErrorCodes.html#gaa2efd953946973972b1afc5d0343820c
[80100066]: https://pcsclite.apdu.fr/api/group__ErrorCodes.html#ga359a9e85e3b7c83c76507a096452b74f
[8010002E]: https://pcsclite.apdu.fr/api/group__ErrorCodes.html#ga81b59e9319d3fcd0d957d98781b3ebd2
[8010000F]: https://pcsclite.apdu.fr/api/group__ErrorCodes.html#ga36d821a0458f935ddbe345f10408a988
### I can't download eSIM profile of xxx.
The verification of SM-DP+ servers of telecom operators is diverse. Please check whether the parameters you enter are consistent with those provided to you by the telecom operators. Some telecom operators issue profiles in the form of push, which may require the use of lpac's discovery and custom IMEI function.

59
docs/LINUX-DIST.md Normal file
View file

@ -0,0 +1,59 @@
# Linux distributions
> [!CAUTION]
>
> **All Linux distribution packages are unofficially maintained.**
## OpenWrt
> Minimum available release: Snapshot
> (Added on 2024-05-15)
```shell
opkg install lpac
```
see <https://github.com/openwrt/packages/blob/master/utils/lpac/Makefile>
## Alpine
> Minimum available release: [v3.20.0](https://pkgs.alpinelinux.org/packages?name=lpac&branch=v3.20)
> (Release date: 2024-05-22).
```shell
pkg install lpac
```
see <https://github.com/alpinelinux/aports/blob/master/community/lpac/APKBUILD>
## Arch Linux
> Need to enable [archlinuxcn repo](https://github.com/archlinuxcn/repo#readme) first
>
> If you want to use AUR, the package name is [lpac-git](https://aur.archlinux.org/packages/lpac-git)
```shell
pacman -S lpac
# or
pacman -S lpac-git
```
see <https://github.com/archlinuxcn/repo/blob/master/archlinuxcn/lpac/PKGBUILD> \
see <https://github.com/archlinuxcn/repo/blob/master/archlinuxcn/lpac-git/PKGBUILD>
## Nix OS
> Need to enable [NUR](https://github.com/nix-community/NUR#readme "Nix User Repository") first
```shell
nix-env -i lpac
```
see <https://github.com/nix-community/nur-combined/blob/master/repos/linyinfeng/pkgs/lpac/default.nix>
## Ubuntu and Debian/Devuan
> Minimum available release: Ubuntu [14.04 Trusty Tahr](https://releases.ubuntu.com/14.04/)
> (Published on 2024-09-01)
see <https://launchpad.net/~daniel-gimpelevich/+archive/ubuntu/ssl/+sourcepub/17063242/+listing-archive-extra>

333
docs/USAGE.md Normal file
View file

@ -0,0 +1,333 @@
## Usage
In Linux, you need to install `pcscd`, `pcsclite` and `libcurl`.
APDU and HTTP interfaces of lpac has several backends, you need to specify `$LPAC_APDU` and `$LPAC_HTTP` environment variables to interface library path. If not specified, it will use `pcsc` and `curl`. See also [environment variables](ENVVARS.md).
Using `at` APDU backend 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 to add yourself into `dialout` group. If your serial port is not `/dev/ttyUSB0`, please use `$AT_DEVICE` to specify which one you want to use.
## CLI
### Command format
```plain
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 libXXXXinterface info
subcommand 2:
Please refer to the detailed instructions below
```
### Return value
The return contents of lpac instructions are all in json format, and the returns of all instructions comply with the following format.
```jsonc
{
"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.
### Subcommand
#### chip
View the EID, default SM-DP+ server and SM-DS server of eUICC. euicc_info2 is also supported.
```plain
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!
```
<details>
<summary>Return value example</summary>
```json
{
"type": "lpa",
"payload": {
"code": 0,
"message": "success",
"data": {
"eidValue": "[EID]",
"EuiccConfiguredAddresses": {
"defaultDpAddress": null,
"rootDsAddress": "testrootsmds.gsma.com"
},
"EUICCInfo2": {
"profileVersion": "2.1.0",
"svn": "2.2.0",
"euiccFirmwareVer": "4.6.0",
"extCardResource": {
"installedApplication": 0,
"freeNonVolatileMemory": 291666,
"freeVolatileMemory": 5970
},
"uiccCapability": [
"usimSupport",
"isimSupport",
"csimSupport",
"akaMilenage",
"akaCave",
"akaTuak128",
"akaTuak256",
"gbaAuthenUsim",
"gbaAuthenISim",
"eapClient",
"javacard",
"multipleUsimSupport",
"multipleIsimSupport"
],
"ts102241Version": "9.2.0",
"globalplatformVersion": "2.3.0",
"rspCapability": [
"additionalProfile",
"testProfileSupport"
],
"euiccCiPKIdListForVerification": [
"81370f5125d0b1d408d4c3b232e6d25e795bebfb"
],
"euiccCiPKIdListForSigning": [
"81370f5125d0b1d408d4c3b232e6d25e795bebfb"
],
"euiccCategory": null,
"forbiddenProfilePolicyRules": [
"pprUpdateControl",
"ppr1"
],
"ppVersion": "0.0.1",
"sasAcreditationNumber": "GI-BA-UP-0419",
"certificationDataObject": {
"platformLabel": "1.2.840.1234567/myPlatformLabel",
"discoveryBaseURL": "https://mycompany.com/myDLOARegistrar"
}
}
}
}
}
```
\* Starting from SGP.22 v2.1, `javacardVersion` is renamed to `ts102241Version` \
\*\* SGP.22 has been a typo, `sasAcreditationNumber` should be `sasAccreditationNumber`
</details>
#### profile
Profile management, you can list, set alias (nickname), enable, disable, delete, download and discovery Profiles.
```plain
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 Download profile from SM-DP server
discovery Detect available profile registered on SM-DS server
```
> [!NOTE]
> Some eUICC chips have trouble when enabling profile (e.g. These removable eUICC cards from ECP), try AID, ICCID, refreshFlag with 1 or 0 to find out the working way for these chips.
There is no secondary confirmation for deleting a Profile, so please perform it with caution.
> [!NOTE]
> This function will only delete the Profile and issue a Notification, but it will not be sent automatically. You need to send it manually.
##### Download requires connection to SM-DP+ server and the following additional parameters:
- `-s`: SM-DP+ server, optional, if not provided, it will try to read the default sm-dp+ 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.
- `-a`: LPA qrcode activation code string, e.g: `LPA:1$<sm-dp+ domain>$<matching id>`, if provided, this option takes precedence over the `-s` and `-m` options, optional.
- `-p`: Interactive preview mode, optional.
<details>
<summary>Example</summary>
```bash
./lpac profile download -s rsp.truphone.com -m "QR-G-5C-1LS-1W1Z9P7"
# LPA qrcode activation code string
./lpac profile download -a 'LPA:1$rsp.truphone.com$QR-G-5C-1LS-1W1Z9P7'
```
</details>
##### Discovery requires connecting to the SM-DS server to query registered profile
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
<details>
<summary>Return value example of lpac profile list</summary>
```json
{
"type": "lpa",
"payload": {
"code": 0,
"message": "success",
"data": [
{
"iccid": "89353...",
"isdpAid": "A0000005591010FFFFFFFF8900001000",
"profileState": "disabled",
"profileNickname": null,
"serviceProviderName": "Vodafone IE",
"profileName": "Vodafone IE eSIM",
"iconType": "png",
"icon": "iVBO...",
"profileClass": "operational"
},
{
"iccid": "89012...",
"isdpAid": "A0000005591010FFFFFFFF8900001100",
"profileState": "disabled",
"profileNickname": null,
"serviceProviderName": "T-Mobile",
"profileName": "CONVSIM5G_Adaptive",
"iconType": "png",
"icon": "iVBO...",
"profileClass": "operational"
},
{
"iccid": "89444...",
"isdpAid": "A0000005591010FFFFFFFF8900001200",
"profileState": "enabled",
"profileNickname": null,
"serviceProviderName": "BetterRoaming",
"profileName": "BetterRoaming",
"iconType": "none",
"icon": null,
"profileClass": "operational"
},
{
"iccid": "89852...",
"isdpAid": "A0000005591010FFFFFFFF8900001300",
"profileState": "disabled",
"profileNickname": null,
"serviceProviderName": "Redtea Mobile",
"profileName": "RedteaGO",
"iconType": "none",
"icon": null,
"profileClass": "operational"
}
]
}
}
```
- `iccid`: ICCID of Profile
- `isdpAid`: Aid of Profile
- `profileState`: State of Profile, "Enabled" or "Disabled"
- `profileNickname`: Nickname of Profile
- `serviceProviderName`: Telecom operators of Profile
- `profileName`: Name of Profile
- `iconType`: Profile icon data struct, "none", "png", "jpg"
- `icon`: Profile icon data in base64
- `profileClass`: Type of Profile
</details>
#### notification
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.
```plain
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>
```
> [!NOTE]
> Downstream developers or end users should process Notification as soon as possible when they exist to comply with GSMA specifications. lpac will not automatically delete the Notification after sending it. You can pass `-r` to `notification process` or you need to delete it manually.
<details>
<summary>Return value example of lpac notification list</summary>
```json
{
"type": "lpa",
"payload": {
"code": 0,
"message": "success",
"data": [
{
"seqNumber": 178,
"profileManagementOperation": "install",
"notificationAddress": "rsp-eu.redteamobile.com",
"iccid": "89852..."
},
{
"seqNumber": 215,
"profileManagementOperation": "disable",
"notificationAddress": "cust-005-v4-prod-atl2.gdsb.net",
"iccid": "89012..."
},
{
"seqNumber": 216,
"profileManagementOperation": "enable",
"notificationAddress": "rsp.truphone.com",
"iccid": "89444..."
}
]
}
}
```
- `seqNumber`: Sequence ID
- `profileManagementOperation`: Which operation generated this notification
- `notificationAddress`: Profile's notification reporting server address
</details>
##### Processing requires connection to server and the following optional parameters:
The following parameters can be used to customize the behavior of `notification process`:
- `-a`: Process all notifications
- `-r`: Automatically remove processed notifications
##### Removing supports the following optional parameters:
The following parameters can be used to customize the behavior of `notification remove`:
- `-a`: Remove all notifications
#### driver
Now, there is only one command: `lpac driver apdu list` to get the card reader list.

View file

@ -3,38 +3,41 @@ DEFINITIONS
AUTOMATIC TAGS AUTOMATIC TAGS
EXTENSIBILITY IMPLIED ::= EXTENSIBILITY IMPLIED ::=
BEGIN BEGIN
IMPORTS Certificate, CertificateList, Time FROM PKIX1Explicit88 {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) id-mod(0) id-pkix1-explicit(18)} IMPORTS Certificate, CertificateList, Time FROM PKIX1Explicit88 {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) id-mod(0) id-pkix1-explicit(18)}
SubjectKeyIdentifier FROM PKIX1Implicit88 {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) id-mod(0) id-pkix1-implicit(19)}; SubjectKeyIdentifier FROM PKIX1Implicit88 {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) id-mod(0) id-pkix1-implicit(19)};
id-rsp OBJECT IDENTIFIER ::= {joint-iso-itu-t(2) international-organizations(23) gsma(146) rsp(1)} id-rsp OBJECT IDENTIFIER ::= {joint-iso-itu-t(2) international-organizations(23) gsma(146) rsp(1)}
-- Basic types, for size constraints -- Basic types, for size constraints
Octet8 ::= OCTET STRING (SIZE(8)) Octet8 ::= OCTET STRING (SIZE(8))
Octet4 ::= OCTET STRING (SIZE(4))
Octet16 ::= OCTET STRING (SIZE(16)) Octet16 ::= OCTET STRING (SIZE(16))
OctetTo16 ::= OCTET STRING (SIZE(1..16)) OctetTo16 ::= OCTET STRING (SIZE(1..16))
Octet32 ::= OCTET STRING (SIZE(32)) Octet32 ::= OCTET STRING (SIZE(32))
Octet1 ::= OCTET STRING(SIZE(1)) Octet1 ::= OCTET STRING(SIZE(1))
Octet2 ::= OCTET STRING (SIZE(2)) Octet2 ::= OCTET STRING (SIZE(2))
VersionType ::= OCTET STRING(SIZE(3)) -- major/minor/revision version are coded as binary value on byte 1/2/3, e.g. '02 00 0C' for v2.0.12. VersionType ::= OCTET STRING(SIZE(3)) -- major/minor/revision version are coded as binary value on byte 1/2/3, e.g. '02 00 0C' for v2.0.12.
-- If revision is not used (e.g. v2.1), byte 3 SHALL be set to '00'.
Iccid ::= [APPLICATION 26] OCTET STRING (SIZE(10)) -- ICCID as coded in EFiccid, corresponding tag is '5A' Iccid ::= [APPLICATION 26] OCTET STRING (SIZE(10)) -- ICCID as coded in EFiccid, corresponding tag is '5A'
RemoteOpId ::= [2] INTEGER {installBoundProfilePackage(1)} RemoteOpId ::= [2] INTEGER {installBoundProfilePackage(1)}
TransactionId ::= OCTET STRING (SIZE(1..16)) TransactionId ::= OCTET STRING (SIZE(1..16))
-- Definition of EUICCInfo1 -------------------------- -- Definition of EUICCInfo1 --------------------------
GetEuiccInfo1Request ::= [32] SEQUENCE { -- Tag 'BF20' GetEuiccInfo1Request ::= [32] SEQUENCE { -- Tag 'BF20'
} }
EUICCInfo1 ::= [32] SEQUENCE { -- Tag 'BF20' EUICCInfo1 ::= [32] SEQUENCE { -- Tag 'BF20'
svn [2] VersionType, -- GSMA SGP.22 version supported (SVN) svn [2] VersionType, -- GSMA SGP.22 version supported (SVN)
euiccCiPKIdListForVerification [9] SEQUENCE OF SubjectKeyIdentifier, -- List of CI Public Key Identifiers supported on the eUICC for signature verification euiccCiPKIdListForVerification [9] SEQUENCE OF SubjectKeyIdentifier, -- List of CI Public Key Identifiers supported on the eUICC for signature verification
euiccCiPKIdListForSigning [10] SEQUENCE OF SubjectKeyIdentifier -- List of CI Public Key Identifier supported on the eUICC for signature creation euiccCiPKIdListForSigning [10] SEQUENCE OF SubjectKeyIdentifier -- List of CI Public Key Identifier supported on the eUICC for signature creation
} }
-- Definition of EUICCInfo2 -------------------------- -- Definition of EUICCInfo2 --------------------------
GetEuiccInfo2Request ::= [34] SEQUENCE { -- Tag 'BF22' GetEuiccInfo2Request ::= [34] SEQUENCE { -- Tag 'BF22'
} }
EUICCInfo2 ::= [34] SEQUENCE { -- Tag 'BF22' EUICCInfo2 ::= [34] SEQUENCE { -- Tag 'BF22'
profileVersion [1] VersionType, -- SIMAlliance Profile package version supported profileVersion [1] VersionType, -- SIMAlliance Profile package version supported
svn [2] VersionType, -- GSMA SGP.22 version supported (SVN) svn [2] VersionType, -- GSMA SGP.22 version supported (SVN)
@ -57,23 +60,24 @@ EUICCInfo2 ::= [34] SEQUENCE { -- Tag 'BF22'
sasAcreditationNumber UTF8String (SIZE(0..64)), sasAcreditationNumber UTF8String (SIZE(0..64)),
certificationDataObject [12] CertificationDataObject OPTIONAL certificationDataObject [12] CertificationDataObject OPTIONAL
} }
-- Definition of RspCapability -- Definition of RspCapability
RspCapability ::= BIT STRING { RspCapability ::= BIT STRING {
additionalProfile(0), -- at least one more Profile can be installed additionalProfile(0), -- at least one more Profile can be installed
crlSupport(1), -- CRL crlSupport(1), -- CRL
rpmSupport(2), -- Remote Profile Management rpmSupport(2), -- Remote Profile Management
testProfileSupport (3) -- support for test profile testProfileSupport (3), -- support for test profile
deviceInfoExtensibilitySupport (4) -- support for ASN.1 extensibility in the Device Info
} }
-- Definition of CertificationDataObject -- Definition of CertificationDataObject
CertificationDataObject ::= SEQUENCE { CertificationDataObject ::= SEQUENCE {
platformLabel UTF8String, -- Platform_Label as defined in GlobalPlatform DLOA specification [57] platformLabel UTF8String, -- Platform_Label as defined in GlobalPlatform DLOA specification [57]
discoveryBaseURL UTF8String -- Discovery Base URL of the SE default DLOA Registrar as defined in GlobalPlatform DLOA specification [57] discoveryBaseURL UTF8String -- Discovery Base URL of the SE default DLOA Registrar as defined in GlobalPlatform DLOA specification [57]
} }
CertificateInfo ::= BIT STRING { CertificateInfo ::= BIT STRING {
reserved(0), -- eUICC has a CERT.EUICC.ECDSA in GlobalPlatform format. The use of this bit is deprecated. reserved(0), -- eUICC has a CERT.EUICC.ECDSA in GlobalPlatform format. The use of this bit is deprecated.
certSigningX509(1), -- eUICC has a CERT.EUICC.ECDSA in X.509 format certSigningX509(1), -- eUICC has a CERT.EUICC.ECDSA in X.509 format
rfu2(2), rfu2(2),
@ -81,42 +85,49 @@ CertificateInfo ::= BIT STRING {
reserved2(4), -- Handling of Certificate in GlobalPlatform format. The use of this bit is deprecated. reserved2(4), -- Handling of Certificate in GlobalPlatform format. The use of this bit is deprecated.
certVerificationX509(5)-- Handling of Certificate in X.509 format certVerificationX509(5)-- Handling of Certificate in X.509 format
} }
-- Definition of UICCCapability -- Definition of UICCCapability
UICCCapability ::= BIT STRING { UICCCapability ::= BIT STRING {
/* Sequence is derived from ServicesList[] defined in SIMalliance PEDefinitions*/ /* Sequence is derived from ServicesList[] defined in SIMalliance PEDefinitions*/
contactlessSupport(0), -- Contactless (SWP, HCI and associated APIs) contactlessSupport(0), -- Contactless (SWP, HCI and associated APIs)
usimSupport(1), -- USIM as defined by 3GPP usimSupport(1), -- USIM as defined by 3GPP
isimSupport(2), -- ISIM as defined by 3GPP isimSupport(2), -- ISIM as defined by 3GPP
csimSupport(3), -- CSIM as defined by 3GPP2 csimSupport(3), -- CSIM as defined by 3GPP2
akaMilenage(4), -- Milenage as AKA algorithm akaMilenage(4), -- Milenage as AKA algorithm
akaCave(5), -- CAVE as authentication algorithm akaCave(5), -- CAVE as authentication algorithm
akaTuak128(6), -- TUAK as AKA algorithm with 128 bit key length akaTuak128(6), -- TUAK as AKA algorithm with 128 bit key length
akaTuak256(7), -- TUAK as AKA algorithm with 256 bit key length akaTuak256(7), -- TUAK as AKA algorithm with 256 bit key length
rfu1(8), -- reserved for further algorithms rfu1(8), -- reserved for further algorithms
rfu2(9), -- reserved for further algorithms rfu2(9), -- reserved for further algorithms
gbaAuthenUsim(10), -- GBA authentication in the context of USIM gbaAuthenUsim(10), -- GBA authentication in the context of USIM
gbaAuthenISim(11), -- GBA authentication in the context of ISIM gbaAuthenISim(11), -- GBA authentication in the context of ISIM
mbmsAuthenUsim(12), -- MBMS authentication in the context of USIM mbmsAuthenUsim(12), -- MBMS authentication in the context of USIM
eapClient(13), -- EAP client eapClient(13), -- EAP client
javacard(14), -- Javacard support javacard(14), -- Javacard support
multos(15), -- Multos support multos(15), -- Multos support
multipleUsimSupport(16), -- Multiple USIM applications are supported within the same Profile multipleUsimSupport(16), -- Multiple USIM applications are supported within the same Profile
multipleIsimSupport(17), -- Multiple ISIM applications are supported within the same Profile multipleIsimSupport(17), -- Multiple ISIM applications are supported within the same Profile
multipleCsimSupport(18) -- Multiple CSIM applications are supported within the same Profile multipleCsimSupport(18), -- Multiple CSIM applications are supported within the same Profile
berTlvFileSupport(19), -- BER TLV files
dfLinkSupport(20), -- Linked Directory Files
catTp(21), -- Support of CAT TP
getIdentity(22), -- Support of the GET IDENTITY command as defined in ETSI TS 102 221 [6]
profile-a-x25519(23), -- Support of ECIES Profile A as defined in 3GPP TS 33.501 [87]
profile-b-p256(24), -- Support of ECIES Profile B as defined in 3GPP TS 33.501 [87]
suciCalculatorApi(25) -- Support of the associated API for SUCI derivation as defined in 3GPP 31.130 [88]
} }
-- Definition of DeviceInfo -- Definition of DeviceInfo
DeviceInfo ::= SEQUENCE { DeviceInfo ::= SEQUENCE {
tac Octet8, tac Octet4,
deviceCapabilities DeviceCapabilities, deviceCapabilities DeviceCapabilities,
imei Octet8 OPTIONAL imei Octet8 OPTIONAL
} }
DeviceCapabilities ::= SEQUENCE { -- Highest fully supported release for each definition DeviceCapabilities ::= SEQUENCE { -- Highest fully supported release for each definition
-- The device SHALL set all the capabilities it supports -- The device SHALL set all the capabilities it supports
gsmSupportedRelease VersionType OPTIONAL, gsmSupportedRelease VersionType OPTIONAL,
@ -124,12 +135,14 @@ DeviceCapabilities ::= SEQUENCE { -- Highest fully supported release for each de
cdma2000onexSupportedRelease VersionType OPTIONAL, cdma2000onexSupportedRelease VersionType OPTIONAL,
cdma2000hrpdSupportedRelease VersionType OPTIONAL, cdma2000hrpdSupportedRelease VersionType OPTIONAL,
cdma2000ehrpdSupportedRelease VersionType OPTIONAL, cdma2000ehrpdSupportedRelease VersionType OPTIONAL,
eutranSupportedRelease VersionType OPTIONAL, eutranEpcSupportedRelease VersionType OPTIONAL,
contactlessSupportedRelease VersionType OPTIONAL, contactlessSupportedRelease VersionType OPTIONAL,
rspCrlSupportedVersion VersionType OPTIONAL, rspCrlSupportedVersion VersionType OPTIONAL,
rspRpmSupportedVersion VersionType OPTIONAL nrEpcSupportedRelease VersionType OPTIONAL,
nr5gcSupportedRelease VersionType OPTIONAL,
eutran5gcSupportedRelease VersionType OPTIONAL
} }
ProfileInfoListRequest ::= [45] SEQUENCE { -- Tag 'BF2D' ProfileInfoListRequest ::= [45] SEQUENCE { -- Tag 'BF2D'
searchCriteria [0] CHOICE { searchCriteria [0] CHOICE {
isdpAid [APPLICATION 15] OctetTo16, -- AID of the ISD-P, tag '4F' isdpAid [APPLICATION 15] OctetTo16, -- AID of the ISD-P, tag '4F'
@ -138,13 +151,13 @@ ProfileInfoListRequest ::= [45] SEQUENCE { -- Tag 'BF2D'
} OPTIONAL, } OPTIONAL,
tagList [APPLICATION 28] OCTET STRING OPTIONAL -- tag '5C' tagList [APPLICATION 28] OCTET STRING OPTIONAL -- tag '5C'
} }
-- Definition of ProfileInfoList -- Definition of ProfileInfoList
ProfileInfoListResponse ::= [45] CHOICE { -- Tag 'BF2D' ProfileInfoListResponse ::= [45] CHOICE { -- Tag 'BF2D'
profileInfoListOk SEQUENCE OF ProfileInfo, profileInfoListOk SEQUENCE OF ProfileInfo,
profileInfoListError ProfileInfoListError profileInfoListError ProfileInfoListError
} }
ProfileInfo ::= [PRIVATE 3] SEQUENCE { -- Tag 'E3' ProfileInfo ::= [PRIVATE 3] SEQUENCE { -- Tag 'E3'
iccid Iccid OPTIONAL, iccid Iccid OPTIONAL,
isdpAid [APPLICATION 15] OctetTo16 OPTIONAL, -- AID of the ISD-P containing the Profile, tag '4F' isdpAid [APPLICATION 15] OctetTo16 OPTIONAL, -- AID of the ISD-P containing the Profile, tag '4F'
@ -154,14 +167,14 @@ ProfileInfo ::= [PRIVATE 3] SEQUENCE { -- Tag 'E3'
profileName [18] UTF8String (SIZE(0..64)) OPTIONAL, -- Tag '92' profileName [18] UTF8String (SIZE(0..64)) OPTIONAL, -- Tag '92'
iconType [19] IconType OPTIONAL, -- Tag '93' iconType [19] IconType OPTIONAL, -- Tag '93'
icon [20] OCTET STRING (SIZE(0..1024)) OPTIONAL, -- Tag '94', see condition in ES10c:GetProfilesInfo icon [20] OCTET STRING (SIZE(0..1024)) OPTIONAL, -- Tag '94', see condition in ES10c:GetProfilesInfo
profileClass [21] ProfileClass DEFAULT operational, -- Tag '95' profileClass [21] ProfileClass OPTIONAL, -- Tag '95'
notificationConfigurationInfo [22] SEQUENCE OF NotificationConfigurationInformation OPTIONAL, -- Tag 'B6' notificationConfigurationInfo [22] SEQUENCE OF NotificationConfigurationInformation OPTIONAL, -- Tag 'B6'
profileOwner [23] OperatorID OPTIONAL, -- Tag 'B7' profileOwner [23] OperatorId OPTIONAL, -- Tag 'B7'
dpProprietaryData [24] DpProprietaryData OPTIONAL, -- Tag 'B8' dpProprietaryData [24] DpProprietaryData OPTIONAL, -- Tag 'B8'
profilePolicyRules [25] PprIds OPTIONAL, -- Tag '99' profilePolicyRules [25] PprIds OPTIONAL, -- Tag '99'
refArDo [118] SEQUENCE OF RefArDo OPTIONAL -- Tag 'BF76' refArDo [118] SEQUENCE OF RefArDo OPTIONAL -- Tag 'BF76'
} }
RefArDo ::= [PRIVATE 2] SEQUENCE { -- Tag 'E2' RefArDo ::= [PRIVATE 2] SEQUENCE { -- Tag 'E2'
refDo [PRIVATE 1] SEQUENCE { -- Tag 'E1' refDo [PRIVATE 1] SEQUENCE { -- Tag 'E1'
deviceAppIdRefDo [PRIVATE 1] OCTET STRING (SIZE(20|32)), -- Tag 'C1' deviceAppIdRefDo [PRIVATE 1] OCTET STRING (SIZE(20|32)), -- Tag 'C1'
@ -171,52 +184,51 @@ RefArDo ::= [PRIVATE 2] SEQUENCE { -- Tag 'E2'
permArDo [PRIVATE 27] OCTET STRING (SIZE(8)) -- Tag 'DB' permArDo [PRIVATE 27] OCTET STRING (SIZE(8)) -- Tag 'DB'
} }
} }
PprIds ::= BIT STRING {-- Definition of Profile Policy Rules identifiers PprIds ::= BIT STRING {-- Definition of Profile Policy Rules identifiers
pprUpdateControl(0), -- defines how to update PPRs via ES6 pprUpdateControl(0), -- defines how to update PPRs via ES6
ppr1(1), -- Indicator for PPR1 'Disabling of this Profile is not allowed' ppr1(1), -- Indicator for PPR1 'Disabling of this Profile is not allowed'
ppr2(2), -- Indicator for PPR2 'Deletion of this Profile is not allowed' ppr2(2) -- Indicator for PPR2 'Deletion of this Profile is not allowed'
ppr3(3) -- Indicator for PPR3 'Deletion of this Profile is required upon its successful disabling'
} }
OperatorID ::= SEQUENCE { OperatorId ::= SEQUENCE {
mccMnc OCTET STRING (SIZE(3)), -- MCC and MNC coded as defined in 3GPP TS 24.008 [32] mccMnc OCTET STRING (SIZE(3)), -- MCC and MNC coded as defined in 3GPP TS 24.008 [32]
gid1 OCTET STRING OPTIONAL, -- referring to content of EF GID1 (file identifier '6F3E') as defined in 3GPP TS 31.102 [54] gid1 OCTET STRING OPTIONAL, -- referring to content of EF GID1 (file identifier '6F3E') as defined in 3GPP TS 31.102 [54]
gid2 OCTET STRING OPTIONAL -- referring to content of EF GID2 (file identifier '6F3F') as defined in 3GPP TS 31.102 [54] gid2 OCTET STRING OPTIONAL -- referring to content of EF GID2 (file identifier '6F3F') as defined in 3GPP TS 31.102 [54]
} }
ProfileInfoListError ::= INTEGER {incorrectInputValues(1), undefinedError(127)} ProfileInfoListError ::= INTEGER {incorrectInputValues(1), undefinedError(127)}
-- Definition of StoreMetadata request -- Definition of StoreMetadata request
StoreMetadataRequest ::= [37] SEQUENCE { -- Tag 'BF25' StoreMetadataRequest ::= [37] SEQUENCE { -- Tag 'BF25'
iccid Iccid, iccid Iccid,
serviceProviderName [17] UTF8String (SIZE(0..32)), -- Tag '91' serviceProviderName [17] UTF8String (SIZE(0..32)), -- Tag '91'
profileName [18] UTF8String (SIZE(0..64)), -- Tag '92' (corresponds to 'Short Description' defined in SGP.21 [2]) profileName [18] UTF8String (SIZE(0..64)), -- Tag '92' (corresponds to 'Short Description' defined in SGP.21 [2])
iconType [19] IconType OPTIONAL, -- Tag '93' (JPG or PNG) iconType [19] IconType OPTIONAL, -- Tag '93' (JPG or PNG)
icon [20] OCTET STRING (SIZE(0..1024)) OPTIONAL, -- Tag '94'(Data of the icon. Size 64 x 64 pixel. This field SHALL only be present if iconType is present) icon [20] OCTET STRING (SIZE(0..1024)) OPTIONAL, -- Tag '94'(Data of the icon. Size 64 x 64 pixel. This field SHALL only be present if iconType is present)
profileClass [21] ProfileClass OPTIONAL, -- Tag '95' (default if absent: 'operational') profileClass [21] ProfileClass DEFAULT operational, -- Tag '95'
notificationConfigurationInfo [22] SEQUENCE OF NotificationConfigurationInformation OPTIONAL, notificationConfigurationInfo [22] SEQUENCE OF NotificationConfigurationInformation OPTIONAL,
profileOwner [23] OperatorID OPTIONAL, -- Tag 'B7' profileOwner [23] OperatorId OPTIONAL, -- Tag 'B7'
profilePolicyRules [25] PprIds OPTIONAL -- Tag '99' profilePolicyRules [25] PprIds OPTIONAL -- Tag '99'
} }
NotificationEvent ::= BIT STRING { NotificationEvent ::= BIT STRING {
notificationInstall (0), notificationInstall (0),
notificationEnable(1), notificationEnable(1),
notificationDisable(2), notificationDisable(2),
notificationDelete(3) notificationDelete(3)
} }
NotificationConfigurationInformation ::= SEQUENCE { NotificationConfigurationInformation ::= SEQUENCE {
profileManagementOperation NotificationEvent, profileManagementOperation NotificationEvent,
notificationAddress UTF8String -- FQDN to forward the notification notificationAddress UTF8String -- FQDN to forward the notification
} }
IconType ::= INTEGER {jpg(0), png(1)} IconType ::= INTEGER {jpg(0), png(1)}
ProfileState ::= INTEGER {disabled(0), enabled(1)} ProfileState ::= INTEGER {disabled(0), enabled(1)}
ProfileClass ::= INTEGER {test(0), provisioning(1), operational(2)} ProfileClass ::= INTEGER {test(0), provisioning(1), operational(2)}
-- Definition of UpdateMetadata request -- Definition of UpdateMetadata request
UpdateMetadataRequest ::= [42] SEQUENCE { -- Tag 'BF2A' UpdateMetadataRequest ::= [42] SEQUENCE { -- Tag 'BF2A'
serviceProviderName [17] UTF8String (SIZE(0..32)) OPTIONAL, -- Tag '91' serviceProviderName [17] UTF8String (SIZE(0..32)) OPTIONAL, -- Tag '91'
@ -225,7 +237,7 @@ UpdateMetadataRequest ::= [42] SEQUENCE { -- Tag 'BF2A'
icon [20] OCTET STRING (SIZE(0..1024)) OPTIONAL, -- Tag '94' icon [20] OCTET STRING (SIZE(0..1024)) OPTIONAL, -- Tag '94'
profilePolicyRules [25] PprIds OPTIONAL -- Tag '99' profilePolicyRules [25] PprIds OPTIONAL -- Tag '99'
} }
-- Definition of data objects for command PrepareDownload ------------------------- -- Definition of data objects for command PrepareDownload -------------------------
PrepareDownloadRequest ::= [33] SEQUENCE { -- Tag 'BF21' PrepareDownloadRequest ::= [33] SEQUENCE { -- Tag 'BF21'
smdpSigned2 SmdpSigned2, -- Signed information smdpSigned2 SmdpSigned2, -- Signed information
@ -233,73 +245,73 @@ PrepareDownloadRequest ::= [33] SEQUENCE { -- Tag 'BF21'
hashCc Octet32 OPTIONAL, -- Hash of confirmation code hashCc Octet32 OPTIONAL, -- Hash of confirmation code
smdpCertificate Certificate -- CERT.DPpb.ECDSA smdpCertificate Certificate -- CERT.DPpb.ECDSA
} }
SmdpSigned2 ::= SEQUENCE { SmdpSigned2 ::= SEQUENCE {
transactionId [0] TransactionId, -- The TransactionID generated by the SM DP+ transactionId [0] TransactionId, -- The TransactionID generated by the SM-DP+
ccRequiredFlag BOOLEAN, --Indicates if the Confirmation Code is required ccRequiredFlag BOOLEAN, --Indicates if the Confirmation Code is required
bppEuiccOtpk [APPLICATION 73] OCTET STRING OPTIONAL -- otPK.EUICC.ECKA already used for binding the BPP, tag '5F49' bppEuiccOtpk [APPLICATION 73] OCTET STRING OPTIONAL -- otPK.EUICC.ECKA already used for binding the BPP, tag '5F49'
} }
PrepareDownloadResponse ::= [33] CHOICE { -- Tag 'BF21' PrepareDownloadResponse ::= [33] CHOICE { -- Tag 'BF21'
downloadResponseOk PrepareDownloadResponseOk, downloadResponseOk PrepareDownloadResponseOk,
downloadResponseError PrepareDownloadResponseError downloadResponseError PrepareDownloadResponseError
} }
PrepareDownloadResponseOk ::= SEQUENCE { PrepareDownloadResponseOk ::= SEQUENCE {
euiccSigned2 EUICCSigned2, -- Signed information euiccSigned2 EUICCSigned2, -- Signed information
euiccSignature2 [APPLICATION 55] OCTET STRING -- tag '5F37' euiccSignature2 [APPLICATION 55] OCTET STRING -- tag '5F37'
} }
EUICCSigned2 ::= SEQUENCE { EUICCSigned2 ::= SEQUENCE {
transactionId [0] TransactionId, transactionId [0] TransactionId,
euiccOtpk [APPLICATION 73] OCTET STRING, -- otPK.EUICC.ECKA, tag '5F49' euiccOtpk [APPLICATION 73] OCTET STRING, -- otPK.EUICC.ECKA, tag '5F49'
hashCc Octet32 OPTIONAL -- Hash of confirmation code hashCc Octet32 OPTIONAL -- Hash of confirmation code
} }
PrepareDownloadResponseError ::= SEQUENCE { PrepareDownloadResponseError ::= SEQUENCE {
transactionId [0] TransactionId, transactionId [0] TransactionId,
downloadErrorCode DownloadErrorCode downloadErrorCode DownloadErrorCode
} }
DownloadErrorCode ::= INTEGER {invalidCertificate(1), invalidSignature(2), unsupportedCurve(3), noSessionContext(4), invalidTransactionId(5), undefinedError(127)} DownloadErrorCode ::= INTEGER {invalidCertificate(1), invalidSignature(2), unsupportedCurve(3), noSessionContext(4), invalidTransactionId(5), undefinedError(127)}
-- Definition of data objects for command AuthenticateServer-------------------- -- Definition of data objects for command AuthenticateServer--------------------
AuthenticateServerRequest ::= [56] SEQUENCE { -- Tag 'BF38' AuthenticateServerRequest ::= [56] SEQUENCE { -- Tag 'BF38'
serverSigned1 ServerSigned1, -- Signed information serverSigned1 ServerSigned1, -- Signed information
serverSignature1 [APPLICATION 55] OCTET STRING, -- tag ?5F37? serverSignature1 [APPLICATION 55] OCTET STRING, -- tag 5F37
euiccCiPKIdToBeUsed SubjectKeyIdentifier, -- CI Public Key Identifier to be used euiccCiPKIdToBeUsed SubjectKeyIdentifier, -- CI Public Key Identifier to be used
serverCertificate Certificate, -- RSP Server Certificate CERT.XXauth.ECDSA serverCertificate Certificate, -- RSP Server Certificate CERT.XXauth.ECDSA
ctxParams1 CtxParams1 ctxParams1 CtxParams1
} }
ServerSigned1 ::= SEQUENCE { ServerSigned1 ::= SEQUENCE {
transactionId [0] TransactionId, -- The Transaction ID generated by the RSP Server transactionId [0] TransactionId, -- The Transaction ID generated by the RSP Server
euiccChallenge [1] Octet16, -- The eUICC Challenge euiccChallenge [1] Octet16, -- The eUICC Challenge
serverAddress [3] UTF8String, -- The RSP Server address serverAddress [3] UTF8String, -- The RSP Server address
serverChallenge [4] Octet16 -- The RSP Server Challenge serverChallenge [4] Octet16 -- The RSP Server Challenge
} }
CtxParams1 ::= CHOICE { CtxParams1 ::= CHOICE {
ctxParamsForCommonAuthentication CtxParamsForCommonAuthentication -- New contextual data objects may be defined for extensibility ctxParamsForCommonAuthentication CtxParamsForCommonAuthentication -- New contextual data objects MAY be defined for extensibility
} }
CtxParamsForCommonAuthentication ::= SEQUENCE { CtxParamsForCommonAuthentication ::= SEQUENCE {
matchingId UTF8String OPTIONAL,-- The MatchingId could be the Activation code token or EventID or empty matchingId UTF8String OPTIONAL,-- The MatchingId could be the Activation code token or EventID or empty
deviceInfo DeviceInfo -- The Device information deviceInfo DeviceInfo -- The Device information
} }
AuthenticateServerResponse ::= [56] CHOICE { -- Tag 'BF38' AuthenticateServerResponse ::= [56] CHOICE { -- Tag 'BF38'
authenticateResponseOk AuthenticateResponseOk, authenticateResponseOk AuthenticateResponseOk,
authenticateResponseError AuthenticateResponseError authenticateResponseError AuthenticateResponseError
} }
AuthenticateResponseOk ::= SEQUENCE { AuthenticateResponseOk ::= SEQUENCE {
euiccSigned1 EuiccSigned1, -- Signed information euiccSigned1 EuiccSigned1, -- Signed information
euiccSignature1 [APPLICATION 55] OCTET STRING, --EUICC_Sign1, tag 5F37 euiccSignature1 [APPLICATION 55] OCTET STRING, --EUICC_Sign1, tag 5F37
euiccCertificate Certificate, -- eUICC Certificate (CERT.EUICC.ECDSA) signed by the EUM euiccCertificate Certificate, -- eUICC Certificate (CERT.EUICC.ECDSA) signed by the EUM
eumCertificate Certificate -- EUM Certificate (CERT.EUM.ECDSA) signed by the requested CI eumCertificate Certificate -- EUM Certificate (CERT.EUM.ECDSA) signed by the requested CI
} }
EuiccSigned1 ::= SEQUENCE { EuiccSigned1 ::= SEQUENCE {
transactionId [0] TransactionId, transactionId [0] TransactionId,
serverAddress [3] UTF8String, serverAddress [3] UTF8String,
@ -307,96 +319,86 @@ EuiccSigned1 ::= SEQUENCE {
euiccInfo2 [34] EUICCInfo2, euiccInfo2 [34] EUICCInfo2,
ctxParams1 CtxParams1 ctxParams1 CtxParams1
} }
AuthenticateResponseError ::= SEQUENCE { AuthenticateResponseError ::= SEQUENCE {
transactionId [0] TransactionId, transactionId [0] TransactionId,
authenticateErrorCode AuthenticateErrorCode authenticateErrorCode AuthenticateErrorCode
} }
AuthenticateErrorCode ::= INTEGER {invalidCertificate(1), invalidSignature(2), unsupportedCurve(3), noSessionContext(4), invalidOid(5), euiccChallengeMismatch(6), ciPKUnknown(7), undefinedError(127)} AuthenticateErrorCode ::= INTEGER {invalidCertificate(1), invalidSignature(2), unsupportedCurve(3), noSessionContext(4), invalidOid(5), euiccChallengeMismatch(6), ciPKUnknown(7), undefinedError(127)}
-- Definition of Cancel Session------------------------------ -- Definition of Cancel Session------------------------------
CancelSessionRequest ::= [65] SEQUENCE { -- Tag 'BF41' CancelSessionRequest ::= [65] SEQUENCE { -- Tag 'BF41'
transactionId TransactionId, -- The TransactionID generated by the RSP Server transactionId TransactionId, -- The TransactionID generated by the RSP Server
reason CancelSessionReason reason CancelSessionReason
} }
CancelSessionReason ::= INTEGER {endUserRejection(0), postponed(1), timeout(2), pprNotAllowed(3)} CancelSessionReason ::= INTEGER {endUserRejection(0), postponed(1), timeout(2), pprNotAllowed(3), metadataMismatch(4), loadBppExecutionError(5), undefinedReason(127)}
CancelSessionResponse ::= [65] CHOICE { -- Tag 'BF41' CancelSessionResponse ::= [65] CHOICE { -- Tag 'BF41'
cancelSessionResponseOk CancelSessionResponseOk, cancelSessionResponseOk CancelSessionResponseOk,
cancelSessionResponseError INTEGER {invalidTransactionId(5), undefinedError(127)} cancelSessionResponseError INTEGER {invalidTransactionId(5), undefinedError(127)}
} }
CancelSessionResponseOk ::= SEQUENCE { CancelSessionResponseOk ::= SEQUENCE {
euiccCancelSessionSigned EuiccCancelSessionSigned, -- Signed information euiccCancelSessionSigned EuiccCancelSessionSigned, -- Signed information
euiccCancelSessionSignature [APPLICATION 55] OCTET STRING -- tag '5F37 euiccCancelSessionSignature [APPLICATION 55] OCTET STRING -- tag '5F37
} }
EuiccCancelSessionSigned ::= SEQUENCE { EuiccCancelSessionSigned ::= SEQUENCE {
transactionId TransactionId, transactionId TransactionId,
smdpOid OBJECT IDENTIFIER, -- SM-DP+ OID as contained in CERT.DPauth.ECDSA smdpOid OBJECT IDENTIFIER, -- SM-DP+ OID as contained in CERT.DPauth.ECDSA
reason CancelSessionReason reason CancelSessionReason
} }
-- asn1c caused some bug when process nested id, so workaround here
BoundProfilePackageTLV87 ::= [7] OCTET STRING
BoundProfilePackageTLV88 ::= [8] OCTET STRING
BoundProfilePackageTLV86 ::= [6] OCTET STRING
SeqBoundProfilePackageTLV87 ::= [0] SEQUENCE OF BoundProfilePackageTLV87
SeqBoundProfilePackageTLV88 ::= [1] SEQUENCE OF BoundProfilePackageTLV88
SeqSecondBoundProfilePackageTLV87 ::= [2] SEQUENCE OF BoundProfilePackageTLV87
SeqBoundProfilePackageTLV86 ::= [3] SEQUENCE OF BoundProfilePackageTLV86
-- Definition of Bound Profile Package -------------------------- -- Definition of Bound Profile Package --------------------------
BoundProfilePackage ::= [54] SEQUENCE { -- Tag 'BF36' BoundProfilePackage ::= [54] SEQUENCE { -- Tag 'BF36'
initialiseSecureChannelRequest [35] InitialiseSecureChannelRequest, -- Tag 'BF23' initialiseSecureChannelRequest [35] InitialiseSecureChannelRequest, -- Tag 'BF23'
firstSequenceOf87 SeqBoundProfilePackageTLV87, -- sequence of '87' TLVs firstSequenceOf87 [0] SEQUENCE OF [7] OCTET STRING, -- sequence of '87' TLVs
sequenceOf88 SeqBoundProfilePackageTLV88, -- sequence of '88' TLVs sequenceOf88 [1] SEQUENCE OF [8] OCTET STRING, -- sequence of '88' TLVs
secondSequenceOf87 SeqSecondBoundProfilePackageTLV87 OPTIONAL, -- sequence of '87' TLVs secondSequenceOf87 [2] SEQUENCE OF [7] OCTET STRING OPTIONAL, -- sequence of '87' TLVs
sequenceOf86 SeqBoundProfilePackageTLV86 -- sequence of '86' TLVs sequenceOf86 [3] SEQUENCE OF [6] OCTET STRING -- sequence of '86' TLVs
} }
-- Definition of Get eUICC Challenge -------------------------- -- Definition of Get eUICC Challenge --------------------------
GetEuiccChallengeRequest ::= [46] SEQUENCE { -- Tag 'BF2E' GetEuiccChallengeRequest ::= [46] SEQUENCE { -- Tag 'BF2E'
} }
GetEuiccChallengeResponse ::= [46] SEQUENCE { -- Tag 'BF2E' GetEuiccChallengeResponse ::= [46] SEQUENCE { -- Tag 'BF2E'
euiccChallenge Octet16 -- random eUICC challenge euiccChallenge Octet16 -- random eUICC challenge
} }
-- Definition of Profile Installation Resulceipt -- Definition of Profile Installation Result
ProfileInstallationResult ::= [55] SEQUENCE { -- Tag 'BF37' ProfileInstallationResult ::= [55] SEQUENCE { -- Tag 'BF37'
profileInstallationResultData [39] ProfileInstallationResultData, profileInstallationResultData [39] ProfileInstallationResultData,
euiccSignPIR EuiccSignPIR euiccSignPIR EuiccSignPIR
} }
ProfileInstallationResultData ::= [39] SEQUENCE { -- Tag 'BF27' ProfileInstallationResultData ::= [39] SEQUENCE { -- Tag 'BF27'
transactionId[0] TransactionId, -- The TransactionID generated by the SM-DP+ transactionId[0] TransactionId, -- The TransactionID generated by the SM-DP+
notificationMetadata[47] NotificationMetadata, notificationMetadata[47] NotificationMetadata,
smdpOid OBJECT IDENTIFIER OPTIONAL, -- SM-DP+ OID (same value as in CERT.DPpb.ECDSA) smdpOid OBJECT IDENTIFIER, -- SM-DP+ OID (same value as in CERT.DPpb.ECDSA)
finalResult [2] CHOICE { finalResult [2] CHOICE {
successResult SuccessResult, successResult SuccessResult,
errorResult ErrorResult errorResult ErrorResult
} }
} }
EuiccSignPIR ::= [APPLICATION 55] OCTET STRING -- Tag '5F37', eUICC?s signature EuiccSignPIR ::= [APPLICATION 55] OCTET STRING -- Tag '5F37', eUICCs signature
SuccessResult ::= SEQUENCE { SuccessResult ::= SEQUENCE {
aid [APPLICATION 15] OCTET STRING (SIZE (5..16)), -- AID of ISD-P aid [APPLICATION 15] OCTET STRING (SIZE (5..16)), -- AID of ISD-P
simaResponse OCTET STRING -- contains (multiple) 'EUICCResponse' as defined in [5] simaResponse OCTET STRING -- contains (multiple) 'EUICCResponse' as defined in [5]
} }
ErrorResult ::= SEQUENCE { ErrorResult ::= SEQUENCE {
bppCommandId BppCommandId, bppCommandId BppCommandId,
errorReason ErrorReason, errorReason ErrorReason,
simaResponse OCTET STRING OPTIONAL -- contains (multiple) 'EUICCResponse' as defined in [5] simaResponse OCTET STRING OPTIONAL -- contains (multiple) 'EUICCResponse' as defined in [5]
} }
BppCommandId ::= INTEGER {initialiseSecureChannel(0), configureISDP(1), storeMetadata(2), storeMetadata2(3), replaceSessionKeys(4), loadProfileElements(5)} BppCommandId ::= INTEGER {initialiseSecureChannel(0), configureISDP(1), storeMetadata(2), storeMetadata2(3), replaceSessionKeys(4), loadProfileElements(5)}
ErrorReason ::= INTEGER { ErrorReason ::= INTEGER {
incorrectInputValues(1), incorrectInputValues(1),
invalidSignature(2), invalidSignature(2),
@ -409,44 +411,44 @@ ErrorReason ::= INTEGER {
installFailedDueToIccidAlreadyExistsOnEuicc(9), installFailedDueToInsufficientMemoryForProfile(10), installFailedDueToIccidAlreadyExistsOnEuicc(9), installFailedDueToInsufficientMemoryForProfile(10),
installFailedDueToInterruption(11), installFailedDueToInterruption(11),
installFailedDueToPEProcessingError (12), installFailedDueToPEProcessingError (12),
installFailedDueToIccidMismatch(13), installFailedDueToDataMismatch(13),
testProfileInstallFailedDueToInvalidNaaKey(14), testProfileInstallFailedDueToInvalidNaaKey(14),
pprNotAllowed(15), pprNotAllowed(15),
installFailedDueToUnknownError(127) installFailedDueToUnknownError(127)
} }
ListNotificationRequest ::= [40] SEQUENCE { -- Tag 'BF28' ListNotificationRequest ::= [40] SEQUENCE { -- Tag 'BF28'
profileManagementOperation [1] NotificationEvent OPTIONAL profileManagementOperation [1] NotificationEvent OPTIONAL
} }
ListNotificationResponse ::= [40] CHOICE { -- Tag 'BF28' ListNotificationResponse ::= [40] CHOICE { -- Tag 'BF28'
notificationMetadataList SEQUENCE OF NotificationMetadata, notificationMetadataList SEQUENCE OF NotificationMetadata,
listNotificationsResultError INTEGER {undefinedError(127)} listNotificationsResultError INTEGER {undefinedError(127)}
} }
NotificationMetadata ::= [47] SEQUENCE { -- Tag 'BF2F' NotificationMetadata ::= [47] SEQUENCE { -- Tag 'BF2F'
seqNumber [0] INTEGER, seqNumber [0] INTEGER,
profileManagementOperation [1] NotificationEvent, --Only one bit set to 1 profileManagementOperation [1] NotificationEvent, --Only one bit SHALL be set to 1
notificationAddress UTF8String, -- FQDN to forward the notification notificationAddress UTF8String, -- FQDN to forward the notification
iccid Iccid OPTIONAL iccid Iccid OPTIONAL
} }
-- Definition of Profile Nickname Information -- Definition of Profile Nickname Information
SetNicknameRequest ::= [41] SEQUENCE { -- Tag 'BF29' SetNicknameRequest ::= [41] SEQUENCE { -- Tag 'BF29'
iccid Iccid, iccid Iccid,
profileNickname [16] UTF8String (SIZE(0..64)) profileNickname [16] UTF8String (SIZE(0..64))
} }
SetNicknameResponse ::= [41] SEQUENCE { -- Tag 'BF29' SetNicknameResponse ::= [41] SEQUENCE { -- Tag 'BF29'
setNicknameResult INTEGER {ok(0), iccidNotFound (1), undefinedError(127)} setNicknameResult INTEGER {ok(0), iccidNotFound (1), undefinedError(127)}
} }
id-rsp-cert-objects OBJECT IDENTIFIER ::= { id-rsp cert-objects(2)} id-rsp-cert-objects OBJECT IDENTIFIER ::= { id-rsp cert-objects(2)}
id-rspExt OBJECT IDENTIFIER ::= {id-rsp-cert-objects 0} id-rspExt OBJECT IDENTIFIER ::= {id-rsp-cert-objects 0}
id-rspRole OBJECT IDENTIFIER ::= {id-rsp-cert-objects 1} id-rspRole OBJECT IDENTIFIER ::= {id-rsp-cert-objects 1}
-- Definition of OIDs for role identification -- Definition of OIDs for role identification
id-rspRole-ci OBJECT IDENTIFIER ::= {id-rspRole 0} id-rspRole-ci OBJECT IDENTIFIER ::= {id-rspRole 0}
id-rspRole-euicc OBJECT IDENTIFIER ::= {id-rspRole 1} id-rspRole-euicc OBJECT IDENTIFIER ::= {id-rspRole 1}
@ -456,7 +458,7 @@ id-rspRole-dp-auth OBJECT IDENTIFIER ::= {id-rspRole 4}
id-rspRole-dp-pb OBJECT IDENTIFIER ::= {id-rspRole 5} id-rspRole-dp-pb OBJECT IDENTIFIER ::= {id-rspRole 5}
id-rspRole-ds-tls OBJECT IDENTIFIER ::= {id-rspRole 6} id-rspRole-ds-tls OBJECT IDENTIFIER ::= {id-rspRole 6}
id-rspRole-ds-auth OBJECT IDENTIFIER ::= {id-rspRole 7} id-rspRole-ds-auth OBJECT IDENTIFIER ::= {id-rspRole 7}
--Definition of data objects for InitialiseSecureChannel Request --Definition of data objects for InitialiseSecureChannel Request
InitialiseSecureChannelRequest ::= [35] SEQUENCE { -- Tag 'BF23' InitialiseSecureChannelRequest ::= [35] SEQUENCE { -- Tag 'BF23'
remoteOpId RemoteOpId, -- Remote Operation Type Identifier (value SHALL be set to installBoundProfilePackage) remoteOpId RemoteOpId, -- Remote Operation Type Identifier (value SHALL be set to installBoundProfilePackage)
@ -465,23 +467,23 @@ InitialiseSecureChannelRequest ::= [35] SEQUENCE { -- Tag 'BF23'
smdpOtpk [APPLICATION 73] OCTET STRING, ---otPK.DP.ECKA as specified in GlobalPlatform Card Specification [8] section 6.4.2.3 for ePK.OCE.ECKA, tag '5F49' smdpOtpk [APPLICATION 73] OCTET STRING, ---otPK.DP.ECKA as specified in GlobalPlatform Card Specification [8] section 6.4.2.3 for ePK.OCE.ECKA, tag '5F49'
smdpSign [APPLICATION 55] OCTET STRING -- SM-DP's signature, tag '5F37' smdpSign [APPLICATION 55] OCTET STRING -- SM-DP's signature, tag '5F37'
} }
ControlRefTemplate ::= SEQUENCE { ControlRefTemplate ::= SEQUENCE {
keyType[0] Octet1, -- Key type according to GlobalPlatform Card Specification [8] Table 11-16, AES= '88', Tag '80' keyType[0] Octet1, -- Key type according to GlobalPlatform Card Specification [8] Table 11-16, AES= '88', Tag '80'
keyLen[1] Octet1, --Key length in number of bytes. For current specification key length SHALL by 0x10 bytes, Tag '81' keyLen[1] Octet1, --Key length in number of bytes. For current specification key length SHALL by 0x10 bytes, Tag '81'
hostId[4] OctetTo16 -- Host ID value , Tag '84' hostId[4] OctetTo16 -- Host ID value , Tag '84'
} }
--Definition of data objects for ConfigureISDPRequest --Definition of data objects for ConfigureISDPRequest
ConfigureISDPRequest ::= [36] SEQUENCE { -- Tag 'BF24' ConfigureISDPRequest ::= [36] SEQUENCE { -- Tag 'BF24'
dpProprietaryData [24] DpProprietaryData OPTIONAL -- Tag 'B8' dpProprietaryData [24] DpProprietaryData OPTIONAL -- Tag 'B8'
} }
DpProprietaryData ::= SEQUENCE { -- maximum size including tag and length field: 128 bytes DpProprietaryData ::= SEQUENCE { -- maximum size including tag and length field: 128 bytes
dpOid OBJECT IDENTIFIER -- OID in the tree of the SM-DP+ that created the Profile dpOid OBJECT IDENTIFIER -- OID in the tree of the SM-DP+ that created the Profile
-- additional data objects defined by the SM-DP+ MAY follow -- additional data objects defined by the SM-DP+ MAY follow
} }
-- Definition of request message for command ReplaceSessionKeys -- Definition of request message for command ReplaceSessionKeys
ReplaceSessionKeysRequest ::= [38] SEQUENCE { -- tag 'BF26' ReplaceSessionKeysRequest ::= [38] SEQUENCE { -- tag 'BF26'
/*The new initial MAC chaining value*/ /*The new initial MAC chaining value*/
@ -491,7 +493,7 @@ ReplaceSessionKeysRequest ::= [38] SEQUENCE { -- tag 'BF26'
/*New session key value of the session key C-MAC computation/verification (PPK-MAC)*/ /*New session key value of the session key C-MAC computation/verification (PPK-MAC)*/
ppkCmac OCTET STRING ppkCmac OCTET STRING
} }
-- Definition of data objects for RetrieveNotificationsList -- Definition of data objects for RetrieveNotificationsList
RetrieveNotificationsListRequest ::= [43] SEQUENCE { -- Tag 'BF2B' RetrieveNotificationsListRequest ::= [43] SEQUENCE { -- Tag 'BF2B'
searchCriteria CHOICE { searchCriteria CHOICE {
@ -499,33 +501,33 @@ RetrieveNotificationsListRequest ::= [43] SEQUENCE { -- Tag 'BF2B'
profileManagementOperation [1] NotificationEvent profileManagementOperation [1] NotificationEvent
} OPTIONAL } OPTIONAL
} }
RetrieveNotificationsListResponse ::= [43] CHOICE { -- Tag 'BF2B' RetrieveNotificationsListResponse ::= [43] CHOICE { -- Tag 'BF2B'
notificationList SEQUENCE OF PendingNotification, notificationList SEQUENCE OF PendingNotification,
notificationsListResultError INTEGER {noResultAvailable(1), undefinedError(127)} notificationsListResultError INTEGER {noResultAvailable(1), undefinedError(127)}
} }
PendingNotification ::= CHOICE { PendingNotification ::= CHOICE {
profileInstallationResult [55] ProfileInstallationResult, -- tag 'BF37' profileInstallationResult [55] ProfileInstallationResult, -- tag 'BF37'
otherSignedNotification OtherSignedNotification otherSignedNotification OtherSignedNotification
} }
OtherSignedNotification ::= SEQUENCE { OtherSignedNotification ::= SEQUENCE {
tbsOtherNotification NotificationMetadata, tbsOtherNotification NotificationMetadata,
euiccNotificationSignature [APPLICATION 55] OCTET STRING, -- eUICC signature of tbsOtherNotification, Tag '5F37' euiccNotificationSignature [APPLICATION 55] OCTET STRING, -- eUICC signature of tbsOtherNotification, Tag '5F37'
euiccCertificate Certificate, -- eUICC Certificate (CERT.EUICC.ECDSA) signed by the EUM euiccCertificate Certificate, -- eUICC Certificate (CERT.EUICC.ECDSA) signed by the EUM
eumCertificate Certificate -- EUM Certificate (CERT.EUM.ECDSA) signed by the requested CI eumCertificate Certificate -- EUM Certificate (CERT.EUM.ECDSA) signed by the requested CI
} }
-- Definition of notificationSent -- Definition of notificationSent
NotificationSentRequest ::= [48] SEQUENCE { -- Tag 'BF30' NotificationSentRequest ::= [48] SEQUENCE { -- Tag 'BF30'
seqNumber [0] INTEGER seqNumber [0] INTEGER
} }
NotificationSentResponse ::= [48] SEQUENCE { -- Tag 'BF30' NotificationSentResponse ::= [48] SEQUENCE { -- Tag 'BF30'
deleteNotificationStatus INTEGER {ok(0), nothingToDelete(1), undefinedError(127)} deleteNotificationStatus INTEGER {ok(0), nothingToDelete(1), undefinedError(127)}
} }
-- Definition of Enable Profile -------------------------- -- Definition of Enable Profile --------------------------
EnableProfileRequest ::= [49] SEQUENCE { -- Tag 'BF31' EnableProfileRequest ::= [49] SEQUENCE { -- Tag 'BF31'
profileIdentifier CHOICE { profileIdentifier CHOICE {
@ -534,11 +536,11 @@ EnableProfileRequest ::= [49] SEQUENCE { -- Tag 'BF31'
}, },
refreshFlag BOOLEAN -- indicating whether REFRESH is required refreshFlag BOOLEAN -- indicating whether REFRESH is required
} }
EnableProfileResponse ::= [49] SEQUENCE { -- Tag 'BF31' EnableProfileResponse ::= [49] SEQUENCE { -- Tag 'BF31'
enableResult INTEGER {ok(0), iccidOrAidNotFound (1), profileNotInDisabledState(2), disallowedByPolicy(3), wrongProfileReenabling(4), undefinedError(127)} enableResult INTEGER {ok(0), iccidOrAidNotFound (1), profileNotInDisabledState(2), disallowedByPolicy(3), wrongProfileReenabling(4), catBusy(5), undefinedError(127)}
} }
-- Definition of Disable Profile -------------------------- -- Definition of Disable Profile --------------------------
DisableProfileRequest ::= [50] SEQUENCE { -- Tag 'BF32' DisableProfileRequest ::= [50] SEQUENCE { -- Tag 'BF32'
profileIdentifier CHOICE { profileIdentifier CHOICE {
@ -547,21 +549,21 @@ DisableProfileRequest ::= [50] SEQUENCE { -- Tag 'BF32'
}, },
refreshFlag BOOLEAN -- indicating whether REFRESH is required refreshFlag BOOLEAN -- indicating whether REFRESH is required
} }
DisableProfileResponse ::= [50] SEQUENCE { -- Tag 'BF32' DisableProfileResponse ::= [50] SEQUENCE { -- Tag 'BF32'
disableResult INTEGER {ok(0), iccidOrAidNotFound (1), profileNotInEnabledState(2), disallowedByPolicy(3), undefinedError(127)} disableResult INTEGER {ok(0), iccidOrAidNotFound (1), profileNotInEnabledState(2), disallowedByPolicy(3), catBusy(5), undefinedError(127)}
} }
-- Definition of Delete Profile -------------------------- -- Definition of Delete Profile --------------------------
DeleteProfileRequest ::= [51] CHOICE { -- Tag 'BF33' DeleteProfileRequest ::= [51] CHOICE { -- Tag 'BF33'
isdpAid [APPLICATION 15] OctetTo16, -- AID, tag '4F' isdpAid [APPLICATION 15] OctetTo16, -- AID, tag '4F'
iccid Iccid -- ICCID, tag '5A' iccid Iccid -- ICCID, tag '5A'
} }
DeleteProfileResponse ::= [51] SEQUENCE { -- Tag 'BF33' DeleteProfileResponse ::= [51] SEQUENCE { -- Tag 'BF33'
deleteResult INTEGER {ok(0), iccidOrAidNotFound (1), profileNotInDisabledState(2), disallowedByPolicy(3), undefinedError(127)} deleteResult INTEGER {ok(0), iccidOrAidNotFound (1), profileNotInDisabledState(2), disallowedByPolicy(3), undefinedError(127)}
} }
-- Definition of Memory Reset -------------------------- -- Definition of Memory Reset --------------------------
EuiccMemoryResetRequest ::= [52] SEQUENCE { -- Tag 'BF34' EuiccMemoryResetRequest ::= [52] SEQUENCE { -- Tag 'BF34'
resetOptions [2] BIT STRING { resetOptions [2] BIT STRING {
@ -569,70 +571,70 @@ EuiccMemoryResetRequest ::= [52] SEQUENCE { -- Tag 'BF34'
deleteFieldLoadedTestProfiles(1), deleteFieldLoadedTestProfiles(1),
resetDefaultSmdpAddress(2)} resetDefaultSmdpAddress(2)}
} }
EuiccMemoryResetResponse ::= [52] SEQUENCE { -- Tag 'BF34' EuiccMemoryResetResponse ::= [52] SEQUENCE { -- Tag 'BF34'
resetResult INTEGER {ok(0), nothingToDelete(1), undefinedError(127)} resetResult INTEGER {ok(0), nothingToDelete(1), catBusy(5), undefinedError(127)}
} }
-- Definition of Get EID -------------------------- -- Definition of Get EID --------------------------
GetEuiccDataRequest ::= [62] SEQUENCE { -- Tag 'BF3E' GetEuiccDataRequest ::= [62] SEQUENCE { -- Tag 'BF3E'
tagList [APPLICATION 28] Octet1 -- tag '5C', the value SHALL be set to '5A' tagList [APPLICATION 28] Octet1 -- tag '5C', the value SHALL be set to '5A'
} }
GetEuiccDataResponse ::= [62] SEQUENCE { -- Tag 'BF3E' GetEuiccDataResponse ::= [62] SEQUENCE { -- Tag 'BF3E'
eidValue [APPLICATION 26] Octet16 -- tag '5A' eidValue [APPLICATION 26] Octet16 -- tag '5A'
} }
-- Definition of Get Rat -- Definition of Get Rat
GetRatRequest ::= [67] SEQUENCE { -- Tag ' BF43' GetRatRequest ::= [67] SEQUENCE { -- Tag ' BF43'
-- No input data -- No input data
} }
GetRatResponse ::= [67] SEQUENCE { -- Tag 'BF43' GetRatResponse ::= [67] SEQUENCE { -- Tag 'BF43'
rat RulesAuthorisationTable rat RulesAuthorisationTable
} }
RulesAuthorisationTable ::= SEQUENCE OF ProfilePolicyAuthorisationRule RulesAuthorisationTable ::= SEQUENCE OF ProfilePolicyAuthorisationRule
ProfilePolicyAuthorisationRule ::= SEQUENCE { ProfilePolicyAuthorisationRule ::= SEQUENCE {
pprIds PprIds, pprIds PprIds,
allowedOperators SEQUENCE OF OperatorID, allowedOperators SEQUENCE OF OperatorId,
pprFlags BIT STRING {consentRequired(0)} pprFlags BIT STRING {consentRequired(0)}
} }
-- Definition of data structure containing the list of CRL segments
SegmentedCrlList ::= SEQUENCE OF CertificateList
-- Definition of data structure command for loading a CRL -- Definition of data structure command for loading a CRL
LoadCRLRequest ::= [53] SEQUENCE { -- Tag 'BF35' LoadCRLRequest ::= [53] SEQUENCE { -- Tag 'BF35'
-- A CRL-A -- A CRL
crl CertificateList crl CertificateList
} }
-- Definition of data structure response for loading a CRL -- Definition of data structure response for loading a CRL
LoadCRLResponse ::= [53] CHOICE { -- Tag 'BF35' LoadCRLResponse ::= [53] CHOICE { -- Tag 'BF35'
loadCRLResponseOk LoadCRLResponseOk, loadCRLResponseOk LoadCRLResponseOk,
loadCRLResponseError LoadCRLResponseError loadCRLResponseError LoadCRLResponseError
} }
LoadCRLResponseOk ::= SEQUENCE { LoadCRLResponseOk ::= SEQUENCE {
missingParts SEQUENCE OF SEQUENCE { missingParts SEQUENCE OF INTEGER OPTIONAL
number INTEGER (0..MAX)
} OPTIONAL
} }
LoadCRLResponseError ::= INTEGER {invalidSignature(1), invalidCRLFormat(2), notEnoughMemorySpace(3), verificationKeyNotFound(4), undefinedError(127)} LoadCRLResponseError ::= INTEGER {invalidSignature(1), invalidCRLFormat(2), notEnoughMemorySpace(3), verificationKeyNotFound(4), fresherCrlAlreadyLoaded(5), baseCrlMissing(6), undefinedError(127)}
-- Definition of the extension for Certificate Expiration Date -- Definition of the extension for Certificate Expiration Date
id-rsp-expDate OBJECT IDENTIFIER ::= {id-rspExt 1} id-rsp-expDate OBJECT IDENTIFIER ::= {id-rspExt 1}
ExpirationDate ::= Time ExpirationDate ::= Time
-- Definition of the extension id for total partial-CRL number -- Definition of the extension id for total partial-CRL number
id-rsp-totalPartialCrlNumber OBJECT IDENTIFIER ::= {id-rspExt 2} id-rsp-totalPartialCrlNumber OBJECT IDENTIFIER ::= {id-rspExt 2}
TotalPartialCrlNumber ::= INTEGER TotalPartialCrlNumber ::= INTEGER
-- Definition of the extension id for the partial-CRL number -- Definition of the extension id for the partial-CRL number
id-rsp-partialCrlNumber OBJECT IDENTIFIER ::= {id-rspExt 3} id-rsp-partialCrlNumber OBJECT IDENTIFIER ::= {id-rspExt 3}
PartialCrlNumber ::= INTEGER PartialCrlNumber ::= INTEGER
-- Definition for ES9+ ASN.1 Binding -------------------------- -- Definition for ES9+ ASN.1 Binding --------------------------
RemoteProfileProvisioningRequest ::= [2] CHOICE { -- Tag 'A2' RemoteProfileProvisioningRequest ::= [2] CHOICE { -- Tag 'A2'
initiateAuthenticationRequest [57] InitiateAuthenticationRequest, -- Tag 'BF39' initiateAuthenticationRequest [57] InitiateAuthenticationRequest, -- Tag 'BF39'
@ -641,7 +643,7 @@ RemoteProfileProvisioningRequest ::= [2] CHOICE { -- Tag 'A2'
cancelSessionRequestEs9 [65] CancelSessionRequestEs9, -- Tag 'BF41' cancelSessionRequestEs9 [65] CancelSessionRequestEs9, -- Tag 'BF41'
handleNotification [61] HandleNotification -- tag 'BF3D' handleNotification [61] HandleNotification -- tag 'BF3D'
} }
RemoteProfileProvisioningResponse ::= [2] CHOICE { -- Tag 'A2' RemoteProfileProvisioningResponse ::= [2] CHOICE { -- Tag 'A2'
initiateAuthenticationResponse [57] InitiateAuthenticationResponse, -- Tag 'BF39' initiateAuthenticationResponse [57] InitiateAuthenticationResponse, -- Tag 'BF39'
authenticateClientResponseEs9 [59] AuthenticateClientResponseEs9, -- Tag 'BF3B' authenticateClientResponseEs9 [59] AuthenticateClientResponseEs9, -- Tag 'BF3B'
@ -649,13 +651,13 @@ RemoteProfileProvisioningResponse ::= [2] CHOICE { -- Tag 'A2'
cancelSessionResponseEs9 [65] CancelSessionResponseEs9, -- Tag 'BF41' cancelSessionResponseEs9 [65] CancelSessionResponseEs9, -- Tag 'BF41'
authenticateClientResponseEs11 [64] AuthenticateClientResponseEs11 -- Tag 'BF40' authenticateClientResponseEs11 [64] AuthenticateClientResponseEs11 -- Tag 'BF40'
} }
InitiateAuthenticationRequest ::= [57] SEQUENCE { -- Tag 'BF39' InitiateAuthenticationRequest ::= [57] SEQUENCE { -- Tag 'BF39'
euiccChallenge [1] Octet16, -- random eUICC challenge euiccChallenge [1] Octet16, -- random eUICC challenge
smdpAddress [3] UTF8String, smdpAddress [3] UTF8String,
euiccInfo1 EUICCInfo1 euiccInfo1 EUICCInfo1
} }
InitiateAuthenticationResponse ::= [57] CHOICE { -- Tag 'BF39' InitiateAuthenticationResponse ::= [57] CHOICE { -- Tag 'BF39'
initiateAuthenticationOk InitiateAuthenticationOkEs9, initiateAuthenticationOk InitiateAuthenticationOkEs9,
initiateAuthenticationError INTEGER { initiateAuthenticationError INTEGER {
@ -664,7 +666,7 @@ InitiateAuthenticationResponse ::= [57] CHOICE { -- Tag 'BF39'
ciPKNotSupported(3) ciPKNotSupported(3)
} }
} }
InitiateAuthenticationOkEs9 ::= SEQUENCE { InitiateAuthenticationOkEs9 ::= SEQUENCE {
transactionId [0] TransactionId, -- The TransactionID generated by the SM-DP+ transactionId [0] TransactionId, -- The TransactionID generated by the SM-DP+
serverSigned1 ServerSigned1, -- Signed information serverSigned1 ServerSigned1, -- Signed information
@ -672,12 +674,12 @@ InitiateAuthenticationOkEs9 ::= SEQUENCE {
euiccCiPKIdToBeUsed SubjectKeyIdentifier, -- The curve CI Public Key to be used as required by ES10b.AuthenticateServer euiccCiPKIdToBeUsed SubjectKeyIdentifier, -- The curve CI Public Key to be used as required by ES10b.AuthenticateServer
serverCertificate Certificate serverCertificate Certificate
} }
AuthenticateClientRequest ::= [59] SEQUENCE { -- Tag 'BF3B' AuthenticateClientRequest ::= [59] SEQUENCE { -- Tag 'BF3B'
transactionId [0] TransactionId, transactionId [0] TransactionId,
authenticateServerResponse [56] AuthenticateServerResponse -- This is the response from ES10b.AuthenticateServer authenticateServerResponse [56] AuthenticateServerResponse -- This is the response from ES10b.AuthenticateServer
} }
AuthenticateClientResponseEs9 ::= [59] CHOICE { -- Tag 'BF3B' AuthenticateClientResponseEs9 ::= [59] CHOICE { -- Tag 'BF3B'
authenticateClientOk AuthenticateClientOk, authenticateClientOk AuthenticateClientOk,
authenticateClientError INTEGER { authenticateClientError INTEGER {
@ -691,21 +693,24 @@ AuthenticateClientResponseEs9 ::= [59] CHOICE { -- Tag 'BF3B'
noEligibleProfile(8), noEligibleProfile(8),
ciPKUnknown(9), ciPKUnknown(9),
invalidTransactionId(10), invalidTransactionId(10),
insufficientMemory(11),
undefinedError(127) undefinedError(127)
} }
} }
AuthenticateClientOk ::= SEQUENCE { AuthenticateClientOk ::= SEQUENCE {
transactionId [0] TransactionId, transactionId [0] TransactionId,
profileMetaData [37] StoreMetadataRequest, profileMetaData [37] StoreMetadataRequest,
prepareDownloadRequest [33] PrepareDownloadRequest smdpSigned2 SmdpSigned2, -- Signed information
smdpSignature2 [APPLICATION 55] OCTET STRING, -- tag '5F37'
smdpCertificate Certificate -- CERT.DPpb.ECDSA
} }
GetBoundProfilePackageRequest ::= [58] SEQUENCE { -- Tag 'BF3A' GetBoundProfilePackageRequest ::= [58] SEQUENCE { -- Tag 'BF3A'
transactionId [0] TransactionId, transactionId [0] TransactionId,
prepareDownloadResponse [33] PrepareDownloadResponse prepareDownloadResponse [33] PrepareDownloadResponse
} }
GetBoundProfilePackageResponse ::= [58] CHOICE { -- Tag 'BF3A' GetBoundProfilePackageResponse ::= [58] CHOICE { -- Tag 'BF3A'
getBoundProfilePackageOk GetBoundProfilePackageOk, getBoundProfilePackageOk GetBoundProfilePackageOk,
getBoundProfilePackageError INTEGER { getBoundProfilePackageError INTEGER {
@ -713,25 +718,27 @@ GetBoundProfilePackageResponse ::= [58] CHOICE { -- Tag 'BF3A'
confirmationCodeMissing(2), confirmationCodeMissing(2),
confirmationCodeRefused(3), confirmationCodeRefused(3),
confirmationCodeRetriesExceeded(4), confirmationCodeRetriesExceeded(4),
bppRebindingRefused(5),
downloadOrderExpired(6),
invalidTransactionId(95), invalidTransactionId(95),
undefinedError(127) undefinedError(127)
} }
} }
GetBoundProfilePackageOk ::= SEQUENCE { GetBoundProfilePackageOk ::= SEQUENCE {
transactionId [0] TransactionId, transactionId [0] TransactionId,
boundProfilePackage [54] BoundProfilePackage boundProfilePackage [54] BoundProfilePackage
} }
HandleNotification ::= [61] SEQUENCE { -- Tag 'BF3D' HandleNotification ::= [61] SEQUENCE { -- Tag 'BF3D'
pendingNotification PendingNotification pendingNotification PendingNotification
} }
CancelSessionRequestEs9 ::= [65] SEQUENCE { -- Tag 'BF41' CancelSessionRequestEs9 ::= [65] SEQUENCE { -- Tag 'BF41'
transactionId TransactionId, transactionId TransactionId,
cancelSessionResponse CancelSessionResponse -- data structure defined for ES10b.CancelSession function cancelSessionResponse CancelSessionResponse -- data structure defined for ES10b.CancelSession function
} }
CancelSessionResponseEs9 ::= [65] CHOICE { -- Tag 'BF41' CancelSessionResponseEs9 ::= [65] CHOICE { -- Tag 'BF41'
cancelSessionOk CancelSessionOk, cancelSessionOk CancelSessionOk,
cancelSessionError INTEGER { cancelSessionError INTEGER {
@ -740,45 +747,45 @@ CancelSessionResponseEs9 ::= [65] CHOICE { -- Tag 'BF41'
undefinedError(127) undefinedError(127)
} }
} }
CancelSessionOk ::= SEQUENCE { -- This function has no output data CancelSessionOk ::= SEQUENCE { -- This function has no output data
} }
EuiccConfiguredAddressesRequest ::= [60] SEQUENCE { -- Tag 'BF3C' EuiccConfiguredAddressesRequest ::= [60] SEQUENCE { -- Tag 'BF3C'
} }
EuiccConfiguredAddressesResponse ::= [60] SEQUENCE { -- Tag 'BF3C' EuiccConfiguredAddressesResponse ::= [60] SEQUENCE { -- Tag 'BF3C'
defaultDpAddress UTF8String OPTIONAL, -- Default SM-DP+ address as an FQDN defaultDpAddress UTF8String OPTIONAL, -- Default SM-DP+ address as an FQDN
rootDsAddress UTF8String -- Root SM-DS address as an FQDN rootDsAddress UTF8String -- Root SM-DS address as an FQDN
} }
ISDRProprietaryApplicationTemplate ::= [PRIVATE 0] SEQUENCE { -- Tag 'E0' ISDRProprietaryApplicationTemplate ::= [PRIVATE 0] SEQUENCE { -- Tag 'E0'
svn [2] VersionType, -- GSMA SGP.22 version supported (SVN) svn [2] VersionType, -- GSMA SGP.22 version supported (SVN)
lpaeSupport BIT STRING { lpaeSupport BIT STRING {
lpaeUsingCat(0), -- LPA in the eUICC using Card Application Toolkit lpaeUsingCat(0), -- LPA in the eUICC using Card Application Toolkit
lpaeUsingScws(1) -- LPA in the eUICC using Smartcard Web Server lpaeUsingScws(1) -- LPA in the eUICC using Smartcard Web Server
} OPTIONAL } OPTIONAL
} }
LpaeActivationRequest ::= [66] SEQUENCE { -- Tag 'BF42' LpaeActivationRequest ::= [66] SEQUENCE { -- Tag 'BF42'
lpaeOption BIT STRING { lpaeOption BIT STRING {
activateCatBasedLpae(0), -- LPAe with LUIe based on CAT activateCatBasedLpae(0), -- LPAe with LUIe based on CAT
activateScwsBasedLpae(1) -- LPAe with LUIe based on SCWS activateScwsBasedLpae(1) -- LPAe with LUIe based on SCWS
} }
} }
LpaeActivationResponse ::= [66] SEQUENCE { -- Tag 'BF42' LpaeActivationResponse ::= [66] SEQUENCE { -- Tag 'BF42'
lpaeActivationResult INTEGER {ok(0), notSupported(1)} lpaeActivationResult INTEGER {ok(0), notSupported(1)}
} }
SetDefaultDpAddressRequest ::= [63] SEQUENCE { -- Tag 'BF3F' SetDefaultDpAddressRequest ::= [63] SEQUENCE { -- Tag 'BF3F'
defaultDpAddress UTF8String -- Default SM-DP+ address as an FQDN defaultDpAddress UTF8String -- Default SM-DP+ address as an FQDN
} }
SetDefaultDpAddressResponse ::= [63] SEQUENCE { -- Tag 'BF3F' SetDefaultDpAddressResponse ::= [63] SEQUENCE { -- Tag 'BF3F'
setDefaultDpAddressResult INTEGER { ok (0), undefinedError (127)} setDefaultDpAddressResult INTEGER { ok (0), undefinedError (127)}
} }
AuthenticateClientResponseEs11 ::= [64] CHOICE { -- Tag 'BF40' AuthenticateClientResponseEs11 ::= [64] CHOICE { -- Tag 'BF40'
authenticateClientOk AuthenticateClientOkEs11, authenticateClientOk AuthenticateClientOkEs11,
authenticateClientError INTEGER { authenticateClientError INTEGER {
@ -792,15 +799,15 @@ AuthenticateClientResponseEs11 ::= [64] CHOICE { -- Tag 'BF40'
undefinedError(127) undefinedError(127)
} }
} }
AuthenticateClientOkEs11 ::= SEQUENCE { AuthenticateClientOkEs11 ::= SEQUENCE {
transactionId TransactionId, transactionId TransactionId,
eventEntries SEQUENCE OF EventEntries eventEntries SEQUENCE OF EventEntries
} }
EventEntries ::= SEQUENCE { EventEntries ::= SEQUENCE {
eventId UTF8String, eventId UTF8String,
rspServerAddress UTF8String rspServerAddress UTF8String
} }
END END

View file

@ -2,8 +2,15 @@ include(CMakeDependentOption)
cmake_dependent_option(LPAC_DYNAMIC_DRIVERS "Build lpac/libeuicc driver backends as a dynamic library" OFF "LPAC_DYNAMIC_LIBEUICC" OFF) cmake_dependent_option(LPAC_DYNAMIC_DRIVERS "Build lpac/libeuicc driver backends as a dynamic library" OFF "LPAC_DYNAMIC_LIBEUICC" OFF)
option(LPAC_WITH_APDU_PCSC "Build APDU PCSC Backend (requires PCSC libraries)" ON) option(LPAC_WITH_APDU_PCSC "Build APDU PCSC Backend (requires PCSC libraries)" ON)
option(LPAC_WITH_APDU_AT "Build APDU AT Backend" ON) if(LINUX)
option(LPAC_WITH_APDU_AT "Build APDU AT Backend" ON)
else()
option(LPAC_WITH_APDU_AT "Build APDU AT Backend" OFF)
endif()
option(LPAC_WITH_APDU_GBINDER "Build APDU Gbinder backend for libhybris devices (requires gbinder headers)" OFF) option(LPAC_WITH_APDU_GBINDER "Build APDU Gbinder backend for libhybris devices (requires gbinder headers)" OFF)
option(LPAC_WITH_APDU_QMI "Build QMI backend for Qualcomm devices (requires libqmi)" OFF)
option(LPAC_WITH_APDU_QMI_QRTR "Build QMI-over-QRTR backend for Qualcomm devices (requires libqrtr and libqmi headers)" OFF)
option(LPAC_WITH_APDU_MBIM "Build MBIM backend for MBIM devices (requires libmbim)" OFF)
option(LPAC_WITH_HTTP_CURL "Build HTTP Curl interface" ON) option(LPAC_WITH_HTTP_CURL "Build HTTP Curl interface" ON)
@ -24,6 +31,7 @@ if(LPAC_WITH_APDU_PCSC)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_APDU_PCSC") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_APDU_PCSC")
target_sources(euicc-drivers PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/apdu/pcsc.c) target_sources(euicc-drivers PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/apdu/pcsc.c)
if(WIN32) if(WIN32)
target_sources(euicc-drivers PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/apdu/pcsc_win32.c)
target_link_libraries(euicc-drivers winscard) target_link_libraries(euicc-drivers winscard)
elseif(APPLE) elseif(APPLE)
target_link_libraries(euicc-drivers "-framework PCSC") target_link_libraries(euicc-drivers "-framework PCSC")
@ -58,13 +66,56 @@ if(LPAC_WITH_APDU_GBINDER)
endif() endif()
endif() endif()
if(LPAC_WITH_APDU_QMI)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_APDU_QMI")
target_sources(euicc-drivers PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/apdu/qmi.c
${CMAKE_CURRENT_SOURCE_DIR}/apdu/qmi_helpers.c
${CMAKE_CURRENT_SOURCE_DIR}/apdu/qmi_common.c)
find_package(PkgConfig REQUIRED)
pkg_check_modules(QMI_GLIB REQUIRED IMPORTED_TARGET qmi-glib>=1.35.5)
target_link_libraries(euicc-drivers PkgConfig::QMI_GLIB)
if(LPAC_DYNAMIC_DRIVERS)
list(APPEND LIBEUICC_DRIVERS_REQUIRES "qmi-glib")
endif()
endif()
if(LPAC_WITH_APDU_QMI_QRTR)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_APDU_QMI_QRTR")
target_sources(euicc-drivers PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/apdu/qmi_qrtr.c
${CMAKE_CURRENT_SOURCE_DIR}/apdu/qmi_helpers.c
${CMAKE_CURRENT_SOURCE_DIR}/apdu/qmi_common.c)
find_package(PkgConfig REQUIRED)
pkg_check_modules(QRTR_GLIB REQUIRED IMPORTED_TARGET qrtr-glib)
pkg_check_modules(QMI_GLIB REQUIRED IMPORTED_TARGET qmi-glib>=1.35.5)
target_link_libraries(euicc-drivers PkgConfig::QRTR_GLIB PkgConfig::QMI_GLIB)
if(LPAC_DYNAMIC_DRIVERS)
list(APPEND LIBEUICC_DRIVERS_REQUIRES "qrtr-glib")
list(APPEND LIBEUICC_DRIVERS_REQUIRES "qmi-glib")
endif()
endif()
if(LPAC_WITH_APDU_MBIM)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_APDU_MBIM")
target_sources(euicc-drivers PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/apdu/mbim.c
${CMAKE_CURRENT_SOURCE_DIR}/apdu/mbim_helpers.c)
find_package(PkgConfig REQUIRED)
pkg_check_modules(MBIM_GLIB REQUIRED IMPORTED_TARGET mbim-glib)
target_link_libraries(euicc-drivers PkgConfig::MBIM_GLIB PkgConfig::MBIM_GLIB)
if(LPAC_DYNAMIC_DRIVERS)
list(APPEND LIBEUICC_DRIVERS_REQUIRES "mbim-glib")
endif()
endif()
if(LPAC_WITH_HTTP_CURL) if(LPAC_WITH_HTTP_CURL)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_HTTP_CURL") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DLPAC_WITH_HTTP_CURL")
target_sources(euicc-drivers PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/http/curl.c) target_sources(euicc-drivers PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/http/curl.c)
if(WIN32) if(WIN32)
target_link_libraries(euicc-drivers ${DL_LIBRARY}) target_link_libraries(euicc-drivers ${DL_LIBRARY})
else() else()
find_package(curl) find_package(CURL REQUIRED)
target_link_libraries(euicc-drivers curl) target_link_libraries(euicc-drivers curl)
if(LPAC_DYNAMIC_DRIVERS) if(LPAC_DYNAMIC_DRIVERS)
list(APPEND LIBEUICC_DRIVERS_REQUIRES "libcurl") list(APPEND LIBEUICC_DRIVERS_REQUIRES "libcurl")

661
driver/LICENSE Normal file
View file

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.

View file

@ -9,22 +9,24 @@
#include <euicc/interface.h> #include <euicc/interface.h>
#include <euicc/hexutil.h> #include <euicc/hexutil.h>
#define AT_BUFFER_SIZE 20480
static FILE *fuart; static FILE *fuart;
static int logic_channel = 0; static int logic_channel = 0;
static char *buffer;
static int at_expect(char **response, const char *expected) static int at_expect(char **response, const char *expected)
{ {
char buffer[1024]; memset(buffer, 0, AT_BUFFER_SIZE);
if (response) if (response)
*response = NULL; *response = NULL;
while (1) while (1)
{ {
fgets(buffer, sizeof(buffer), fuart); fgets(buffer, AT_BUFFER_SIZE, fuart);
buffer[strcspn(buffer, "\r\n")] = 0; buffer[strcspn(buffer, "\r\n")] = 0;
if (getenv("AT_DEBUG")) if (getenv("AT_DEBUG"))
printf("AT_DEBUG: %s\r\n", buffer); printf("AT_DEBUG: %s\n", buffer);
if (strcmp(buffer, "ERROR") == 0) if (strcmp(buffer, "ERROR") == 0)
{ {
return -1; return -1;
@ -59,6 +61,7 @@ static int apdu_interface_connect(struct euicc_ctx *ctx)
fprintf(stderr, "Failed to open device: %s\n", device); fprintf(stderr, "Failed to open device: %s\n", device);
return -1; return -1;
} }
setbuf(fuart, NULL);
fprintf(fuart, "AT+CCHO=?\r\n"); fprintf(fuart, "AT+CCHO=?\r\n");
if (at_expect(NULL, NULL)) if (at_expect(NULL, NULL))
@ -110,7 +113,7 @@ static int apdu_interface_transmit(struct euicc_ctx *ctx, uint8_t **rx, uint32_t
fprintf(fuart, "%02X", (uint8_t)(tx[i] & 0xFF)); fprintf(fuart, "%02X", (uint8_t)(tx[i] & 0xFF));
} }
fprintf(fuart, "\"\r\n"); fprintf(fuart, "\"\r\n");
if (at_expect(&response, "+CGLA: ")) if (at_expect(&response, "+CGLA:"))
{ {
goto err; goto err;
} }
@ -210,6 +213,13 @@ static int libapduinterface_init(struct euicc_apdu_interface *ifstruct)
ifstruct->logic_channel_close = apdu_interface_logic_channel_close; ifstruct->logic_channel_close = apdu_interface_logic_channel_close;
ifstruct->transmit = apdu_interface_transmit; ifstruct->transmit = apdu_interface_transmit;
buffer = malloc(AT_BUFFER_SIZE);
if (!buffer)
{
fprintf(stderr, "Failed to allocate memory\n");
return -1;
}
return 0; return 0;
} }
@ -218,8 +228,9 @@ static int libapduinterface_main(int argc, char **argv)
return 0; return 0;
} }
static void libapduinterface_fini(void) static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{ {
free(buffer);
} }
const struct euicc_driver driver_apdu_at = { const struct euicc_driver driver_apdu_at = {
@ -227,5 +238,5 @@ const struct euicc_driver driver_apdu_at = {
.name = "at", .name = "at",
.init = (int (*)(void *))libapduinterface_init, .init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main, .main = libapduinterface_main,
.fini = libapduinterface_fini, .fini = (void (*)(void *))libapduinterface_fini,
}; };

View file

@ -90,7 +90,7 @@ static GBinderLocalReply *radio_response_transact(
case HIDL_SERVICE_ICC_OPEN_LOGICAL_CHANNEL_CALLBACK: case HIDL_SERVICE_ICC_OPEN_LOGICAL_CHANNEL_CALLBACK:
gbinder_reader_read_int32(&reader, &lastIntResp); gbinder_reader_read_int32(&reader, &lastIntResp);
break; break;
case HIDL_SERVICE_ICC_TRANSMIT_APDU_LOGICAL_CHANNEL_CALLBACK: case HIDL_SERVICE_ICC_TRANSMIT_APDU_LOGICAL_CHANNEL_CALLBACK: {
const struct icc_io_result *icc_io_res = gbinder_reader_read_hidl_struct(&reader, struct icc_io_result); const struct icc_io_result *icc_io_res = gbinder_reader_read_hidl_struct(&reader, struct icc_io_result);
// We cannot rely on the *req pointer being valid after we return // We cannot rely on the *req pointer being valid after we return
lastIccIoResult.sw1 = icc_io_res->sw1; lastIccIoResult.sw1 = icc_io_res->sw1;
@ -99,6 +99,7 @@ static GBinderLocalReply *radio_response_transact(
lastIccIoResult.simResponse.len = icc_io_res->simResponse.len; lastIccIoResult.simResponse.len = icc_io_res->simResponse.len;
lastIccIoResult.simResponse.owns_buffer = TRUE; lastIccIoResult.simResponse.owns_buffer = TRUE;
break; break;
}
} }
out: out:
@ -314,14 +315,14 @@ static int libapduinterface_main(int argc, char **argv)
return 0; return 0;
} }
static void libapduinterface_fini(void) static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{ {
} }
const struct euicc_driver driver_apdu_gbinder_hidl = { const struct euicc_driver driver_apdu_gbinder_hidl = {
.type = DRIVER_APDU, .type = DRIVER_APDU,
.name = "gbinder_hidl", .name = "gbinder_hidl",
.init = libapduinterface_init, .init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main, .main = libapduinterface_main,
.fini = libapduinterface_fini, .fini = (void (*)(void *))libapduinterface_fini,
}; };

367
driver/apdu/mbim.c Normal file
View file

@ -0,0 +1,367 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Frans Klaver <frans.klaver@vislink.com>
*/
#include "mbim.h"
#include <libmbim-glib.h>
#include <stdio.h>
#include <euicc/interface.h>
#include <euicc/euicc.h>
#include "mbim_helpers.h"
struct mbim_data {
const char *device_path;
int last_channel_id;
gboolean use_proxy;
guint32 uim_slot;
GMainContext *context;
MbimDevice *device;
};
static gboolean is_sim_available(struct mbim_data *mbim_priv)
{
MbimMessage *request = mbim_message_subscriber_ready_status_query_new(NULL);
g_autoptr(MbimMessage) response = mbim_device_command_sync(
mbim_priv->device, mbim_priv->context, request, NULL
);
if (!response)
return FALSE;
MbimSubscriberReadyState ready_state;
if (!mbim_message_subscriber_ready_status_response_parse(
response, &ready_state, NULL, NULL, NULL, NULL, NULL, NULL
)) {
return FALSE;
}
switch (ready_state) {
case MBIM_SUBSCRIBER_READY_STATE_NO_ESIM_PROFILE:
case MBIM_SUBSCRIBER_READY_STATE_INITIALIZED:
return TRUE;
default:
return FALSE;
}
}
static int select_sim_slot(struct mbim_data *mbim_priv)
{
g_autoptr(GError) error = NULL;
MbimMessage *current_slot_request =
mbim_message_ms_basic_connect_extensions_device_slot_mappings_query_new(NULL);
g_autoptr(MbimMessage) current_slot_response = mbim_device_command_sync(
mbim_priv->device, mbim_priv->context, current_slot_request, &error
);
if (!current_slot_response) {
fprintf(stderr, "error: device didn't respond: %s\n", error->message);
return -1;
}
guint32 current_slot_count;
g_autoptr(MbimSlotArray) current_slots = NULL;
if (!mbim_message_ms_basic_connect_extensions_device_slot_mappings_response_parse(
current_slot_response, &current_slot_count, &current_slots, &error
)) {
fprintf(stderr, "error: sim select response could not be parsed: %s\n", error->message);
return -1;
}
if (current_slot_count && current_slots[0]->slot == mbim_priv->uim_slot) {
return 0;
}
g_autoptr(GPtrArray) new_slot_array = g_ptr_array_new_with_free_func(g_free);
MbimSlot *new_slot = g_new(MbimSlot, 1);
new_slot->slot = mbim_priv->uim_slot;
g_ptr_array_add(new_slot_array, new_slot);
MbimMessage *update_slot_request = mbim_message_ms_basic_connect_extensions_device_slot_mappings_set_new(
new_slot_array->len, (const MbimSlot **)new_slot_array->pdata, &error
);
if (!update_slot_request) {
fprintf(stderr, "error: unable to select sim slot: %s\n", error->message);
return -1;
}
g_autoptr(MbimMessage) update_slot_response = mbim_device_command_sync(
mbim_priv->device, mbim_priv->context, update_slot_request, &error
);
if (!update_slot_response) {
fprintf(stderr, "error: device didn't respond: %s\n", error->message);
return -1;
}
guint32 slot_count;
g_autoptr(MbimSlotArray) updated_slots = NULL;
if (!mbim_message_ms_basic_connect_extensions_device_slot_mappings_response_parse(
update_slot_response, &slot_count, &updated_slots, &error
)) {
fprintf(stderr, "error: sim select response could not be parsed: %s\n", error->message);
return -1;
}
int retries = 20;
while (retries--) {
if (is_sim_available(mbim_priv)) {
return 0;
}
}
fprintf(stderr, "sim did not become available\n");
return -1;
}
static int apdu_interface_connect(struct euicc_ctx *ctx)
{
struct mbim_data *mbim_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
GFile *file;
file = g_file_new_for_path(mbim_priv->device_path);
mbim_priv->context = g_main_context_new();
mbim_priv->device = mbim_device_new_from_path(file, mbim_priv->context, &error);
if (!mbim_priv->device) {
fprintf(stderr, "error: create mbim device from path failed: %s\n", error->message);
return -1;
}
MbimDeviceOpenFlags open_flags = MBIM_DEVICE_OPEN_FLAGS_NONE;
if (mbim_priv->use_proxy)
open_flags |= MBIM_DEVICE_OPEN_FLAGS_PROXY;
mbim_device_open_sync(mbim_priv->device, open_flags, mbim_priv->context, &error);
if (error) {
fprintf(stderr, "error: open mbim device failed: %s\n", error->message);
return -1;
}
return select_sim_slot(mbim_priv);
}
/*
* Allocate storage in rx and copy the contents of response_data there. Also
* tack the status at the end, as the MBIM protocol separates the status from
* the rest of the response.
*/
static int copy_data_with_status(
uint8_t **rx, uint32_t *rx_len,
const guint8 *response_data, guint32 response_size,
guint32 status)
{
*rx_len = response_size + 2;
*rx = malloc(*rx_len);
if (!*rx)
return -1;
memcpy(*rx, response_data, response_size);
(*rx)[*rx_len - 2] = status & 0xff;
(*rx)[*rx_len - 1] = (status >> 8) & 0xff;
return 0;
}
static int mbim_apdu_interface_transmit(
struct euicc_ctx *ctx,
uint8_t **rx, uint32_t *rx_len,
const uint8_t *tx, uint32_t tx_len)
{
struct mbim_data *mbim_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
MbimMessage *request = mbim_message_ms_uicc_low_level_access_apdu_set_new(
mbim_priv->last_channel_id,
MBIM_UICC_SECURE_MESSAGING_NONE,
MBIM_UICC_CLASS_BYTE_TYPE_INTER_INDUSTRY,
tx_len,
tx,
&error
);
if (!request) {
fprintf(stderr, "error: creating apdu message failed: %s\n", error->message);
return -1;
}
g_autoptr(MbimMessage) response = mbim_device_command_sync(
mbim_priv->device, mbim_priv->context, request, &error
);
if (!response) {
fprintf(stderr, "error: no apdu response received: %s\n", error->message);
return -1;
}
guint32 status = 0;
guint32 response_size = 0;
const guint8 *response_data = NULL;
if (!mbim_message_ms_uicc_low_level_access_apdu_response_parse(
response, &status, &response_size, &response_data, &error
)) {
fprintf(stderr, "error: unable to parse apdu response: %s\n", error->message);
return -1;
}
return copy_data_with_status(rx, rx_len, response_data, response_size, status);
}
static int mbim_apdu_interface_logic_channel_open(
struct euicc_ctx *ctx,
const uint8_t *aid,
uint8_t aid_len)
{
struct mbim_data *mbim_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
guint8 channel_id;
MbimMessage *request = mbim_message_ms_uicc_low_level_access_open_channel_set_new(
aid_len, aid, 0, 1, &error
);
if (!request) {
fprintf(stderr, "error: creating channel message failed: %s\n", error->message);
return -1;
}
g_autoptr(MbimMessage) response = mbim_device_command_sync(
mbim_priv->device, mbim_priv->context, request, &error
);
if (!response) {
fprintf(stderr, "error: no channel response received: %s\n", error->message);
return -1;
}
guint32 status = 0;
guint32 channel = -1;
guint32 response_size = 0;
const guint8 *response_data = NULL;
if (!mbim_message_ms_uicc_low_level_access_open_channel_response_parse(
response, &status, &channel, &response_size, &response_data, &error
)) {
fprintf(stderr, "error: unable to parse channel response: %s\n", error->message);
return -1;
}
mbim_priv->last_channel_id = channel;
return channel;
}
static void mbim_apdu_interface_logic_channel_close(struct euicc_ctx *ctx, uint8_t channel)
{
struct mbim_data *mbim_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
MbimMessage *request = mbim_message_ms_uicc_low_level_access_close_channel_set_new(
channel, 1, &error
);
if (!request) {
fprintf(stderr, "error: creating channel message failed: %s\n", error->message);
return;
}
g_autoptr(MbimMessage) response = mbim_device_command_sync(
mbim_priv->device, mbim_priv->context, request, &error
);
if (!response) {
fprintf(stderr, "error: no channel response received: %s\n", error->message);
return;
}
guint32 status = 0;
if (!mbim_message_ms_uicc_low_level_access_close_channel_response_parse(
response, &status, &error
)) {
fprintf(stderr, "error: unable to parse channel response: %s\n", error->message);
return;
}
if (channel == mbim_priv->last_channel_id)
mbim_priv->last_channel_id = -1;
}
static void mbim_apdu_interface_disconnect(struct euicc_ctx *ctx)
{
struct mbim_data *mbim_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
if (mbim_priv->last_channel_id > 0)
{
fprintf(stderr, "Cleaning up leaked APDU channel %d\n", mbim_priv->last_channel_id);
mbim_apdu_interface_logic_channel_close(NULL, mbim_priv->last_channel_id);
mbim_priv->last_channel_id = -1;
}
mbim_device_close_sync(mbim_priv->device, mbim_priv->context, &error);
g_main_context_unref(mbim_priv->context);
mbim_priv->context = NULL;
}
static int libapduinterface_init(struct euicc_apdu_interface *ifstruct)
{
struct mbim_data *mbim_priv;
guint32 uim_slot = 0;
/*
* We're using the same UIM_SLOT environment variable as the QMI backends.
* QMI uses 1-based indexing for the sim slots. MBIM uses 0-based indexing,
* so account for that.
*/
const char *env_uim_slot = getenv("UIM_SLOT");
if (env_uim_slot) {
uim_slot = atoi(env_uim_slot);
if (uim_slot == 0) {
fprintf(stderr, "error: Invalid UIM_SLOT: '%s'\n", env_uim_slot);
return -1;
}
uim_slot--;
}
mbim_priv = malloc(sizeof(struct mbim_data));
if (!mbim_priv) {
fprintf(stderr, "Failed allocating memory\n");
return -1;
}
mbim_priv->uim_slot = uim_slot;
const char *use_proxy = getenv("MBIM_USE_PROXY");
if (use_proxy && strcmp(use_proxy, "0") != 0) {
mbim_priv->use_proxy = TRUE;
}
if (!(mbim_priv->device_path = getenv("MBIM_DEVICE"))) {
mbim_priv->device_path = "/dev/cdc-wdm0";
}
memset(ifstruct, 0, sizeof(struct euicc_apdu_interface));
ifstruct->connect = apdu_interface_connect;
ifstruct->disconnect = mbim_apdu_interface_disconnect;
ifstruct->logic_channel_open = mbim_apdu_interface_logic_channel_open;
ifstruct->logic_channel_close = mbim_apdu_interface_logic_channel_close;
ifstruct->transmit = mbim_apdu_interface_transmit;
ifstruct->userdata = mbim_priv;
return 0;
}
static int libapduinterface_main(int argc, char **argv)
{
return 0;
}
static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{
g_free(ifstruct->userdata);
}
const struct euicc_driver driver_apdu_mbim = {
.type = DRIVER_APDU,
.name = "mbim",
.init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main,
.fini = (void (*)(void *))libapduinterface_fini,
};

8
driver/apdu/mbim.h Normal file
View file

@ -0,0 +1,8 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Frans Klaver <frans.klaver@vislink.com>
*/
#pragma once
#include <driver.private.h>
extern const struct euicc_driver driver_apdu_mbim;

111
driver/apdu/mbim_helpers.c Normal file
View file

@ -0,0 +1,111 @@
// SPDX-License-Identifier: MIT
/*
Copyright (c) 2024, Frans Klaver <frans.klaver@vislink.com>
*/
#include "mbim_helpers.h"
#include <libmbim-glib.h>
static void
async_result_ready(GObject *source_object,
GAsyncResult *res,
gpointer user_data)
{
GAsyncResult **result_out = user_data;
g_assert(*result_out == NULL);
*result_out = g_object_ref(res);
}
MbimDevice *
mbim_device_new_from_path(GFile *file,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
g_autofree gchar *id = NULL;
pusher = g_main_context_pusher_new(context);
id = g_file_get_path (file);
if (id)
mbim_device_new(file,
NULL,
async_result_ready,
&result);
while (!result)
g_main_context_iteration(context, TRUE);
return mbim_device_new_finish(result, error);
}
gboolean
mbim_device_open_sync(MbimDevice *device,
MbimDeviceOpenFlags open_flags,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
mbim_device_open_full(device,
open_flags,
15,
NULL,
async_result_ready,
&result);
while (!result)
g_main_context_iteration(context, TRUE);
return mbim_device_open_finish(device, result, error);
}
MbimMessage *
mbim_device_command_sync(MbimDevice *device, GMainContext *context, MbimMessage *request, GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
mbim_device_command(device, request, 10, NULL, async_result_ready, &result);
mbim_message_unref(request);
while (result == NULL)
g_main_context_iteration(context, TRUE);
MbimMessage *response = mbim_device_command_finish(device, result, error);
if (!response) {
return NULL;
}
if (!mbim_message_response_get_result(response, MBIM_MESSAGE_TYPE_COMMAND_DONE, error)) {
return NULL;
}
return response;
}
gboolean
mbim_device_close_sync(
MbimDevice *device,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
mbim_device_close(device, 20, NULL, async_result_ready, &result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return mbim_device_close_finish(device, result, error);
}

View file

@ -0,0 +1,32 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Frans Klaver <frans.klaver@vislink.com>
*/
#pragma once
#include <libmbim-glib.h>
MbimDevice *
mbim_device_new_from_path(
GFile *file,
GMainContext *context,
GError **error);
gboolean
mbim_device_open_sync(
MbimDevice *device,
MbimDeviceOpenFlags open_flags,
GMainContext *context,
GError **error);
gboolean
mbim_device_close_sync(
MbimDevice *device,
GMainContext *context,
GError **error);
MbimMessage *
mbim_device_command_sync(
MbimDevice *device,
GMainContext *context,
MbimMessage *request,
GError **error);

View file

@ -7,6 +7,7 @@
#ifdef _WIN32 #ifdef _WIN32
#include <winscard.h> #include <winscard.h>
#include "pcsc_win32.h"
#else #else
#include <PCSC/wintypes.h> #include <PCSC/wintypes.h>
#include <PCSC/winscard.h> #include <PCSC/winscard.h>
@ -29,6 +30,10 @@ static SCARDCONTEXT pcsc_ctx;
static SCARDHANDLE pcsc_hCard; static SCARDHANDLE pcsc_hCard;
static LPSTR pcsc_mszReaders; static LPSTR pcsc_mszReaders;
static void pcsc_error(const char *method, const int32_t code) {
fprintf(stderr, "%s failed: %08X (%s)\n", method, code, pcsc_stringify_error(code));
}
static int pcsc_ctx_open(void) static int pcsc_ctx_open(void)
{ {
int ret; int ret;
@ -41,7 +46,7 @@ static int pcsc_ctx_open(void)
ret = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &pcsc_ctx); ret = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &pcsc_ctx);
if (ret != SCARD_S_SUCCESS) if (ret != SCARD_S_SUCCESS)
{ {
fprintf(stderr, "SCardEstablishContext() failed: %08X\n", ret); pcsc_error("SCardEstablishContext()", ret);
return -1; return -1;
} }
@ -54,7 +59,7 @@ static int pcsc_ctx_open(void)
ret = SCardListReaders(pcsc_ctx, NULL, NULL, &dwReaders); ret = SCardListReaders(pcsc_ctx, NULL, NULL, &dwReaders);
if (ret != SCARD_S_SUCCESS) if (ret != SCARD_S_SUCCESS)
{ {
fprintf(stderr, "SCardListReaders() failed: %08X\n", ret); pcsc_error("SCardListReaders()", ret);
return -1; return -1;
} }
pcsc_mszReaders = malloc(sizeof(char) * dwReaders); pcsc_mszReaders = malloc(sizeof(char) * dwReaders);
@ -67,7 +72,7 @@ static int pcsc_ctx_open(void)
#endif #endif
if (ret != SCARD_S_SUCCESS) if (ret != SCARD_S_SUCCESS)
{ {
fprintf(stderr, "SCardListReaders() failed: %08X\n", ret); pcsc_error("SCardListReaders()", ret);
return -1; return -1;
} }
@ -121,7 +126,7 @@ static int pcsc_open_hCard_iter(int index, const char *reader, void *userdata)
ret = SCardConnect(pcsc_ctx, reader, SCARD_SHARE_EXCLUSIVE, SCARD_PROTOCOL_T0, &pcsc_hCard, &dwActiveProtocol); ret = SCardConnect(pcsc_ctx, reader, SCARD_SHARE_EXCLUSIVE, SCARD_PROTOCOL_T0, &pcsc_hCard, &dwActiveProtocol);
if (ret != SCARD_S_SUCCESS) if (ret != SCARD_S_SUCCESS)
{ {
fprintf(stderr, "SCardConnect() failed: %08X\n", ret); pcsc_error("SCardConnect()", ret);
return -1; return -1;
} }
@ -168,7 +173,7 @@ static int pcsc_transmit_lowlevel(uint8_t *rx, uint32_t *rx_len, const uint8_t *
ret = SCardTransmit(pcsc_hCard, SCARD_PCI_T0, tx, tx_len, NULL, rx, &rx_len_merged); ret = SCardTransmit(pcsc_hCard, SCARD_PCI_T0, tx, tx_len, NULL, rx, &rx_len_merged);
if (ret != SCARD_S_SUCCESS) if (ret != SCARD_S_SUCCESS)
{ {
fprintf(stderr, "SCardTransmit() failed: %08X\n", ret); pcsc_error("SCardTransmit()", ret);
return -1; return -1;
} }
@ -453,7 +458,7 @@ static int libapduinterface_main(int argc, char **argv)
return 0; return 0;
} }
static void libapduinterface_fini(void) static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{ {
} }
@ -462,5 +467,6 @@ const struct euicc_driver driver_apdu_pcsc = {
.name = "pcsc", .name = "pcsc",
.init = (int (*)(void *))libapduinterface_init, .init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main, .main = libapduinterface_main,
.fini = libapduinterface_fini, .fini = (void (*)(void *))libapduinterface_fini,
}; };

83
driver/apdu/pcsc_win32.c Normal file
View file

@ -0,0 +1,83 @@
#ifdef _WIN32
#include "pcsc_win32.h"
#define PCSC_ERROR_CASE(NAME) case NAME: return #NAME
const char *pcsc_stringify_error(const LONG err) {
switch (err) {
PCSC_ERROR_CASE(SCARD_S_SUCCESS);
PCSC_ERROR_CASE(SCARD_F_INTERNAL_ERROR);
PCSC_ERROR_CASE(SCARD_E_CANCELLED);
PCSC_ERROR_CASE(SCARD_E_INVALID_HANDLE);
PCSC_ERROR_CASE(SCARD_E_INVALID_PARAMETER);
PCSC_ERROR_CASE(SCARD_E_INVALID_TARGET);
PCSC_ERROR_CASE(SCARD_E_NO_MEMORY);
PCSC_ERROR_CASE(SCARD_F_WAITED_TOO_LONG);
PCSC_ERROR_CASE(SCARD_E_INSUFFICIENT_BUFFER);
PCSC_ERROR_CASE(SCARD_E_UNKNOWN_READER);
PCSC_ERROR_CASE(SCARD_E_TIMEOUT);
PCSC_ERROR_CASE(SCARD_E_SHARING_VIOLATION);
PCSC_ERROR_CASE(SCARD_E_NO_SMARTCARD);
PCSC_ERROR_CASE(SCARD_E_UNKNOWN_CARD);
PCSC_ERROR_CASE(SCARD_E_CANT_DISPOSE);
PCSC_ERROR_CASE(SCARD_E_PROTO_MISMATCH);
PCSC_ERROR_CASE(SCARD_E_NOT_READY);
PCSC_ERROR_CASE(SCARD_E_INVALID_VALUE);
PCSC_ERROR_CASE(SCARD_E_SYSTEM_CANCELLED);
PCSC_ERROR_CASE(SCARD_F_COMM_ERROR);
PCSC_ERROR_CASE(SCARD_F_UNKNOWN_ERROR);
PCSC_ERROR_CASE(SCARD_E_INVALID_ATR);
PCSC_ERROR_CASE(SCARD_E_NOT_TRANSACTED);
PCSC_ERROR_CASE(SCARD_E_READER_UNAVAILABLE);
PCSC_ERROR_CASE(SCARD_P_SHUTDOWN);
PCSC_ERROR_CASE(SCARD_E_PCI_TOO_SMALL);
PCSC_ERROR_CASE(SCARD_E_READER_UNSUPPORTED);
PCSC_ERROR_CASE(SCARD_E_DUPLICATE_READER);
PCSC_ERROR_CASE(SCARD_E_CARD_UNSUPPORTED);
PCSC_ERROR_CASE(SCARD_E_NO_SERVICE);
PCSC_ERROR_CASE(SCARD_E_SERVICE_STOPPED);
PCSC_ERROR_CASE(SCARD_E_UNEXPECTED);
PCSC_ERROR_CASE(SCARD_E_ICC_INSTALLATION);
PCSC_ERROR_CASE(SCARD_E_ICC_CREATEORDER);
PCSC_ERROR_CASE(SCARD_E_UNSUPPORTED_FEATURE);
PCSC_ERROR_CASE(SCARD_E_DIR_NOT_FOUND);
PCSC_ERROR_CASE(SCARD_E_FILE_NOT_FOUND);
PCSC_ERROR_CASE(SCARD_E_NO_DIR);
PCSC_ERROR_CASE(SCARD_E_NO_FILE);
PCSC_ERROR_CASE(SCARD_E_NO_ACCESS);
PCSC_ERROR_CASE(SCARD_E_WRITE_TOO_MANY);
PCSC_ERROR_CASE(SCARD_E_BAD_SEEK);
PCSC_ERROR_CASE(SCARD_E_INVALID_CHV);
PCSC_ERROR_CASE(SCARD_E_UNKNOWN_RES_MNG);
PCSC_ERROR_CASE(SCARD_E_NO_SUCH_CERTIFICATE);
PCSC_ERROR_CASE(SCARD_E_CERTIFICATE_UNAVAILABLE);
PCSC_ERROR_CASE(SCARD_E_NO_READERS_AVAILABLE);
PCSC_ERROR_CASE(SCARD_E_COMM_DATA_LOST);
PCSC_ERROR_CASE(SCARD_E_NO_KEY_CONTAINER);
PCSC_ERROR_CASE(SCARD_E_SERVER_TOO_BUSY);
PCSC_ERROR_CASE(SCARD_E_PIN_CACHE_EXPIRED);
PCSC_ERROR_CASE(SCARD_E_NO_PIN_CACHE);
PCSC_ERROR_CASE(SCARD_E_READ_ONLY_CARD);
PCSC_ERROR_CASE(SCARD_W_UNSUPPORTED_CARD);
PCSC_ERROR_CASE(SCARD_W_UNRESPONSIVE_CARD);
PCSC_ERROR_CASE(SCARD_W_UNPOWERED_CARD);
PCSC_ERROR_CASE(SCARD_W_RESET_CARD);
PCSC_ERROR_CASE(SCARD_W_REMOVED_CARD);
PCSC_ERROR_CASE(SCARD_W_SECURITY_VIOLATION);
PCSC_ERROR_CASE(SCARD_W_WRONG_CHV);
PCSC_ERROR_CASE(SCARD_W_CHV_BLOCKED);
PCSC_ERROR_CASE(SCARD_W_EOF);
PCSC_ERROR_CASE(SCARD_W_CANCELLED_BY_USER);
PCSC_ERROR_CASE(SCARD_W_CARD_NOT_AUTHENTICATED);
PCSC_ERROR_CASE(SCARD_W_CACHE_ITEM_NOT_FOUND);
PCSC_ERROR_CASE(SCARD_W_CACHE_ITEM_STALE);
PCSC_ERROR_CASE(ERROR_IO_DEVICE);
PCSC_ERROR_CASE(ERROR_BROKEN_PIPE);
default:
return "Unknown error";
}
}
#undef PCSC_ERROR_CASE
#endif

6
driver/apdu/pcsc_win32.h Normal file
View file

@ -0,0 +1,6 @@
#pragma once
#ifdef _WIN32
#include <winscard.h>
const char *pcsc_stringify_error(LONG);
#endif

101
driver/apdu/qmi.c Normal file
View file

@ -0,0 +1,101 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Robert Marko <robert.marko@sartura.hr>
*/
#include "qmi.h"
#include <stdio.h>
#include "qmi_common.h"
static int apdu_interface_connect(struct euicc_ctx *ctx)
{
struct qmi_data *qmi_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
QmiDevice *device = NULL;
QmiClient *client = NULL;
const char *device_path;
GFile *file;
if (!(device_path = getenv("QMI_DEVICE"))) {
fprintf(stderr, "No QMI device path specified!\n");
return -1;
}
file = g_file_new_for_path(device_path);
qmi_priv->context = g_main_context_new();
device = qmi_device_new_from_path(file, qmi_priv->context, &error);
if (!device) {
fprintf(stderr, "error: create QMI device from path failed: %s\n", error->message);
return -1;
}
qmi_device_open_sync(device, QMI_DEVICE_OPEN_FLAGS_PROXY, qmi_priv->context, &error);
if (error) {
fprintf(stderr, "error: open QMI device failed: %s\n", error->message);
return -1;
}
client = qmi_device_allocate_client_sync(device, qmi_priv->context, &error);
if (!client) {
fprintf(stderr, "error: allocate QMI client failed: %s\n", error->message);
return -1;
}
qmi_priv->uimClient = QMI_CLIENT_UIM(client);
return 0;
}
static int libapduinterface_init(struct euicc_apdu_interface *ifstruct)
{
struct qmi_data *qmi_priv;
qmi_priv = calloc(1, sizeof(struct qmi_data));
if(!qmi_priv) {
fprintf(stderr, "Failed allocating memory\n");
return -1;
}
memset(ifstruct, 0, sizeof(struct euicc_apdu_interface));
ifstruct->connect = apdu_interface_connect;
ifstruct->disconnect = qmi_apdu_interface_disconnect;
ifstruct->logic_channel_open = qmi_apdu_interface_logic_channel_open;
ifstruct->logic_channel_close = qmi_apdu_interface_logic_channel_close;
ifstruct->transmit = qmi_apdu_interface_transmit;
/*
* Allow the user to select the SIM card slot via environment variable.
* Use the primary SIM slot if not set.
*/
if (getenv("UIM_SLOT"))
qmi_priv->uimSlot = atoi(getenv("UIM_SLOT"));
else
qmi_priv->uimSlot = 1;
ifstruct->userdata = qmi_priv;
return 0;
}
static int libapduinterface_main(int argc, char **argv)
{
return 0;
}
static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{
struct qmi_data *qmi_priv = ifstruct->userdata;
qmi_cleanup(qmi_priv);
free(qmi_priv);
}
const struct euicc_driver driver_apdu_qmi = {
.type = DRIVER_APDU,
.name = "qmi",
.init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main,
.fini = (void (*)(void *))libapduinterface_fini,
};

8
driver/apdu/qmi.h Normal file
View file

@ -0,0 +1,8 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Robert Marko <robert.marko@sartura.hr>
*/
#pragma once
#include <driver.private.h>
extern const struct euicc_driver driver_apdu_qmi;

163
driver/apdu/qmi_common.c Normal file
View file

@ -0,0 +1,163 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Luca Weiss <luca.weiss@fairphone.com>
*/
#include <stdio.h>
#include "qmi_common.h"
int qmi_apdu_interface_transmit(struct euicc_ctx *ctx, uint8_t **rx, uint32_t *rx_len, const uint8_t *tx, uint32_t tx_len)
{
struct qmi_data *qmi_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
g_autoptr(GArray) apdu_data = NULL;
/* Convert tx into request GArray */
apdu_data = g_array_new(FALSE, FALSE, sizeof(guint8));
for (uint32_t i = 0; i < tx_len; i++)
g_array_append_val(apdu_data, tx[i]);
QmiMessageUimSendApduInput *input;
input = qmi_message_uim_send_apdu_input_new();
qmi_message_uim_send_apdu_input_set_slot(input, qmi_priv->uimSlot, NULL);
qmi_message_uim_send_apdu_input_set_channel_id(input, qmi_priv->lastChannelId, NULL);
qmi_message_uim_send_apdu_input_set_apdu(input, apdu_data, NULL);
QmiMessageUimSendApduOutput *output;
output = qmi_client_uim_send_apdu_sync(qmi_priv->uimClient, input, qmi_priv->context, &error);
qmi_message_uim_send_apdu_input_unref(input);
if (!qmi_message_uim_send_apdu_output_get_result(output, &error))
{
fprintf(stderr, "error: send apdu operation failed: %s\n", error->message);
return -1;
}
GArray *apdu_res = NULL;
if (!qmi_message_uim_send_apdu_output_get_apdu_response(output, &apdu_res, &error))
{
fprintf(stderr, "error: get apdu response operation failed: %s\n", error->message);
return -1;
}
/* Convert response GArray into rx */
*rx_len = apdu_res->len;
*rx = malloc(*rx_len);
if (!*rx)
return -1;
for (guint i = 0; i < apdu_res->len; i++)
(*rx)[i] = apdu_res->data[i];
qmi_message_uim_send_apdu_output_unref(output);
return 0;
}
int qmi_apdu_interface_logic_channel_open(struct euicc_ctx *ctx, const uint8_t *aid, uint8_t aid_len)
{
struct qmi_data *qmi_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
guint8 channel_id;
GArray *aid_data = g_array_new(FALSE, FALSE, sizeof(guint8));
for (int i = 0; i < aid_len; i++)
g_array_append_val(aid_data, aid[i]);
QmiMessageUimOpenLogicalChannelInput *input;
input = qmi_message_uim_open_logical_channel_input_new();
qmi_message_uim_open_logical_channel_input_set_slot(input, qmi_priv->uimSlot, NULL);
qmi_message_uim_open_logical_channel_input_set_aid(input, aid_data, NULL);
QmiMessageUimOpenLogicalChannelOutput *output;
output = qmi_client_uim_open_logical_channel_sync(qmi_priv->uimClient, input, qmi_priv->context, &error);
qmi_message_uim_open_logical_channel_input_unref(input);
g_array_unref(aid_data);
if (!output)
{
fprintf(stderr, "error: send Open Logical Channel command failed: %s\n", error->message);
return -1;
}
if (!qmi_message_uim_open_logical_channel_output_get_result(output, &error))
{
fprintf(stderr, "error: open logical channel operation failed: %s\n", error->message);
return -1;
}
if (!qmi_message_uim_open_logical_channel_output_get_channel_id(output, &channel_id, &error))
{
fprintf(stderr, "error: get channel id operation failed: %s\n", error->message);
return -1;
}
qmi_priv->lastChannelId = channel_id;
g_debug("Opened logical channel with id %d", channel_id);
qmi_message_uim_open_logical_channel_output_unref(output);
return channel_id;
}
void qmi_apdu_interface_logic_channel_close(struct euicc_ctx *ctx, uint8_t channel)
{
struct qmi_data *qmi_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
QmiMessageUimLogicalChannelInput *input;
input = qmi_message_uim_logical_channel_input_new();
qmi_message_uim_logical_channel_input_set_slot(input, qmi_priv->uimSlot, NULL);
qmi_message_uim_logical_channel_input_set_channel_id(input, channel, NULL);
QmiMessageUimLogicalChannelOutput *output;
output = qmi_client_uim_logical_channel_sync(qmi_priv->uimClient, input, qmi_priv->context, &error);
qmi_message_uim_logical_channel_input_unref(input);
if (error)
{
fprintf(stderr, "error: send Close Logical Channel command failed: %s\n", error->message);
return;
}
if (!qmi_message_uim_logical_channel_output_get_result(output, &error))
{
fprintf(stderr, "error: logical channel operation failed: %s\n", error->message);
return;
}
/* Mark channel as having been cleaned up */
if (channel == qmi_priv->lastChannelId)
qmi_priv->lastChannelId = -1;
g_debug("Closed logical channel with id %d", channel);
qmi_message_uim_logical_channel_output_unref(output);
}
void qmi_apdu_interface_disconnect(struct euicc_ctx *ctx)
{
struct qmi_data *qmi_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
QmiClient *client = QMI_CLIENT(qmi_priv->uimClient);
QmiDevice *device = QMI_DEVICE(qmi_client_get_device(client));
qmi_device_release_client_sync(device, client, qmi_priv->context, &error);
qmi_priv->uimClient = NULL;
g_main_context_unref(qmi_priv->context);
qmi_priv->context = NULL;
}
void qmi_cleanup(struct qmi_data *qmi_priv)
{
if (qmi_priv->lastChannelId > 0)
{
fprintf(stderr, "Cleaning up leaked APDU channel %d\n", qmi_priv->lastChannelId);
qmi_apdu_interface_logic_channel_close(NULL, qmi_priv->lastChannelId);
qmi_priv->lastChannelId = -1;
}
}

21
driver/apdu/qmi_common.h Normal file
View file

@ -0,0 +1,21 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Luca Weiss <luca.weiss@fairphone.com>
*/
#pragma once
#include <euicc/interface.h>
#include <euicc/euicc.h>
#include "qmi_helpers.h"
struct qmi_data {
int lastChannelId;
int uimSlot;
GMainContext *context;
QmiClientUim *uimClient;
};
int qmi_apdu_interface_transmit(struct euicc_ctx *ctx, uint8_t **rx, uint32_t *rx_len, const uint8_t *tx, uint32_t tx_len);
int qmi_apdu_interface_logic_channel_open(struct euicc_ctx *ctx, const uint8_t *aid, uint8_t aid_len);
void qmi_apdu_interface_logic_channel_close(struct euicc_ctx *ctx, uint8_t channel);
void qmi_apdu_interface_disconnect(struct euicc_ctx *ctx);
void qmi_cleanup(struct qmi_data *qmi_priv);

234
driver/apdu/qmi_helpers.c Normal file
View file

@ -0,0 +1,234 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Luca Weiss <luca.weiss@fairphone.com>
*/
#include "qmi_helpers.h"
static void
async_result_ready(GObject *source_object,
GAsyncResult *res,
gpointer user_data)
{
GAsyncResult **result_out = user_data;
g_assert(*result_out == NULL);
*result_out = g_object_ref(res);
}
#ifdef LPAC_WITH_APDU_QMI_QRTR
QrtrBus *
qrtr_bus_new_sync(GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qrtr_bus_new(1000, /* ms */
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qrtr_bus_new_finish(result, error);
}
QmiDevice *
qmi_device_new_from_node_sync(QrtrNode *node,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_device_new_from_node(node,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_device_new_from_node_finish(result, error);
}
#endif
#ifdef LPAC_WITH_APDU_QMI
QmiDevice *
qmi_device_new_from_path(GFile *file,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
g_autofree gchar *id = NULL;
pusher = g_main_context_pusher_new(context);
id = g_file_get_path (file);
if (id)
qmi_device_new(file,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_device_new_finish(result, error);
}
#endif
gboolean
qmi_device_open_sync(QmiDevice *device,
QmiDeviceOpenFlags flags,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_device_open(device,
flags,
15,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_device_open_finish(device, result, error);
}
QmiClient *
qmi_device_allocate_client_sync(QmiDevice *device,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_device_allocate_client(device,
QMI_SERVICE_UIM,
QMI_CID_NONE,
10,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_device_allocate_client_finish(device, result, error);
}
gboolean
qmi_device_release_client_sync(QmiDevice *device,
QmiClient *client,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_device_release_client(device,
client,
QMI_DEVICE_RELEASE_CLIENT_FLAGS_RELEASE_CID,
10,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_device_release_client_finish(device, result, error);
}
QmiMessageUimOpenLogicalChannelOutput *
qmi_client_uim_open_logical_channel_sync(
QmiClientUim *client,
QmiMessageUimOpenLogicalChannelInput *input,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_client_uim_open_logical_channel(client,
input,
10,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_client_uim_open_logical_channel_finish(client, result, error);
}
QmiMessageUimLogicalChannelOutput *
qmi_client_uim_logical_channel_sync(
QmiClientUim *client,
QmiMessageUimLogicalChannelInput *input,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_client_uim_logical_channel(client,
input,
10,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_client_uim_logical_channel_finish(client, result, error);
}
QmiMessageUimSendApduOutput *
qmi_client_uim_send_apdu_sync(
QmiClientUim *client,
QmiMessageUimSendApduInput *input,
GMainContext *context,
GError **error)
{
g_autoptr(GMainContextPusher) pusher = NULL;
g_autoptr(GAsyncResult) result = NULL;
pusher = g_main_context_pusher_new(context);
qmi_client_uim_send_apdu(client,
input,
10,
NULL,
async_result_ready,
&result);
while (result == NULL)
g_main_context_iteration(context, TRUE);
return qmi_client_uim_send_apdu_finish(client, result, error);
}

69
driver/apdu/qmi_helpers.h Normal file
View file

@ -0,0 +1,69 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Luca Weiss <luca.weiss@fairphone.com>
*/
#pragma once
#include <libqmi-glib.h>
#ifdef LPAC_WITH_APDU_QMI_QRTR
#include <libqrtr-glib.h>
QrtrBus *qrtr_bus_new_sync(
GMainContext *context,
GError **error);
QmiDevice *
qmi_device_new_from_node_sync(
QrtrNode *node,
GMainContext *context,
GError **error);
#endif
#ifdef LPAC_WITH_APDU_QMI
QmiDevice *
qmi_device_new_from_path(
GFile *file,
GMainContext *context,
GError **error);
#endif
gboolean
qmi_device_open_sync(
QmiDevice *device,
QmiDeviceOpenFlags flags,
GMainContext *context,
GError **error);
QmiClient *
qmi_device_allocate_client_sync(
QmiDevice *device,
GMainContext *context,
GError **error);
gboolean
qmi_device_release_client_sync(
QmiDevice *device,
QmiClient *client,
GMainContext *context,
GError **error);
QmiMessageUimOpenLogicalChannelOutput *
qmi_client_uim_open_logical_channel_sync(
QmiClientUim *client,
QmiMessageUimOpenLogicalChannelInput *input,
GMainContext *context,
GError **error);
QmiMessageUimLogicalChannelOutput *
qmi_client_uim_logical_channel_sync(
QmiClientUim *client,
QmiMessageUimLogicalChannelInput *input,
GMainContext *context,
GError **error);
QmiMessageUimSendApduOutput *
qmi_client_uim_send_apdu_sync(
QmiClientUim *client,
QmiMessageUimSendApduInput *input,
GMainContext *context,
GError **error);

136
driver/apdu/qmi_qrtr.c Normal file
View file

@ -0,0 +1,136 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Luca Weiss <luca.weiss@fairphone.com>
*/
#include "qmi_qrtr.h"
#include <euicc/interface.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <libqrtr-glib.h>
#include "qmi_common.h"
static QrtrBus *bus = NULL;
static int apdu_interface_connect(struct euicc_ctx *ctx)
{
struct qmi_data *qmi_priv = ctx->apdu.interface->userdata;
g_autoptr(GError) error = NULL;
QrtrNode *node = NULL;
QmiDevice *device = NULL;
QmiClient *client = NULL;
bool found = false;
qmi_priv->context = g_main_context_new();
bus = qrtr_bus_new_sync(qmi_priv->context, &error);
if (bus == NULL)
{
fprintf(stderr, "error: connect to QRTR bus failed: %s\n", error->message);
return -1;
}
/* Find QRTR node for UIM service */
for (GList *l = qrtr_bus_peek_nodes(bus); l != NULL; l = l->next)
{
node = l->data;
if (node && qrtr_node_lookup_port(node, QMI_SERVICE_UIM) >= 0)
{
found = true;
break;
}
}
if (!found)
{
fprintf(stderr, "error: find QRTR node with UIM service failed\n");
return -1;
}
device = qmi_device_new_from_node_sync(node, qmi_priv->context, &error);
if (!device)
{
fprintf(stderr, "error: create QMI device from QRTR node failed: %s\n", error->message);
return -1;
}
qmi_device_open_sync(device, QMI_DEVICE_OPEN_FLAGS_NONE, qmi_priv->context, &error);
if (error)
{
fprintf(stderr, "error: open QMI device failed: %s\n", error->message);
return -1;
}
client = qmi_device_allocate_client_sync(device, qmi_priv->context, &error);
if (!client)
{
fprintf(stderr, "error: allocate QMI client failed: %s\n", error->message);
return -1;
}
qmi_priv->uimClient = QMI_CLIENT_UIM(client);
return 0;
}
static int libapduinterface_init(struct euicc_apdu_interface *ifstruct)
{
struct qmi_data *qmi_priv;
qmi_priv = malloc(sizeof(struct qmi_data));
if(!qmi_priv) {
fprintf(stderr, "Failed allocating memory\n");
return -1;
}
memset(ifstruct, 0, sizeof(struct euicc_apdu_interface));
ifstruct->connect = apdu_interface_connect;
ifstruct->disconnect = qmi_apdu_interface_disconnect;
ifstruct->logic_channel_open = qmi_apdu_interface_logic_channel_open;
ifstruct->logic_channel_close = qmi_apdu_interface_logic_channel_close;
ifstruct->transmit = qmi_apdu_interface_transmit;
/*
* Allow the user to select the SIM card slot via environment variable.
* Use the primary SIM slot if not set.
*/
if (getenv("UIM_SLOT"))
{
qmi_priv->uimSlot = atoi(getenv("UIM_SLOT"));
}
else
{
qmi_priv->uimSlot = 1;
}
ifstruct->userdata = qmi_priv;
return 0;
}
static int libapduinterface_main(int argc, char **argv)
{
return 0;
}
static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{
struct qmi_data *qmi_priv = ifstruct->userdata;
qmi_cleanup(qmi_priv);
free(qmi_priv);
}
const struct euicc_driver driver_apdu_qmi_qrtr = {
.type = DRIVER_APDU,
.name = "qmi_qrtr",
.init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main,
.fini = (void (*)(void *))libapduinterface_fini,
};

8
driver/apdu/qmi_qrtr.h Normal file
View file

@ -0,0 +1,8 @@
// SPDX-License-Identifier: MIT
/*
* Copyright (c) 2024, Luca Weiss <luca.weiss@fairphone.com>
*/
#pragma once
#include <driver.private.h>
extern const struct euicc_driver driver_apdu_qmi_qrtr;

View file

@ -43,7 +43,7 @@ static int afgets(char **obuf, FILE *fp)
} }
} }
(*obuf)[strcspn(*obuf, "\r\n")] = 0; (*obuf)[strcspn(*obuf, "\n")] = 0;
return 0; return 0;
@ -87,7 +87,7 @@ static int json_print(cJSON *jpayload)
} }
cJSON_Delete(jroot); cJSON_Delete(jroot);
fprintf(stdout, "%s\r\n", jstr); fprintf(stdout, "%s\n", jstr);
fflush(stdout); fflush(stdout);
free(jstr); free(jstr);
@ -340,7 +340,7 @@ static int libapduinterface_main(int argc, char **argv)
return 0; return 0;
} }
static void libapduinterface_fini(void) static void libapduinterface_fini(struct euicc_apdu_interface *ifstruct)
{ {
} }
@ -349,5 +349,5 @@ const struct euicc_driver driver_apdu_stdio = {
.name = "stdio", .name = "stdio",
.init = (int (*)(void *))libapduinterface_init, .init = (int (*)(void *))libapduinterface_init,
.main = libapduinterface_main, .main = libapduinterface_main,
.fini = libapduinterface_fini, .fini = (void (*)(void *))libapduinterface_fini,
}; };

View file

@ -8,6 +8,18 @@
#include "driver/apdu/gbinder_hidl.h" #include "driver/apdu/gbinder_hidl.h"
#endif #endif
#ifdef LPAC_WITH_APDU_MBIM
#include "driver/apdu/mbim.h"
#endif
#ifdef LPAC_WITH_APDU_QMI
#include "driver/apdu/qmi.h"
#endif
#ifdef LPAC_WITH_APDU_QMI_QRTR
#include "driver/apdu/qmi_qrtr.h"
#endif
#ifdef LPAC_WITH_APDU_PCSC #ifdef LPAC_WITH_APDU_PCSC
#include "driver/apdu/pcsc.h" #include "driver/apdu/pcsc.h"
#endif #endif
@ -24,6 +36,15 @@ static const struct euicc_driver *drivers[] = {
#ifdef LPAC_WITH_APDU_GBINDER #ifdef LPAC_WITH_APDU_GBINDER
&driver_apdu_gbinder_hidl, &driver_apdu_gbinder_hidl,
#endif #endif
#ifdef LPAC_WITH_APDU_MBIM
&driver_apdu_mbim,
#endif
#ifdef LPAC_WITH_APDU_QMI
&driver_apdu_qmi,
#endif
#ifdef LPAC_WITH_APDU_QMI_QRTR
&driver_apdu_qmi_qrtr,
#endif
#ifdef LPAC_WITH_APDU_PCSC #ifdef LPAC_WITH_APDU_PCSC
&driver_apdu_pcsc, &driver_apdu_pcsc,
#endif #endif
@ -105,10 +126,10 @@ void euicc_driver_fini()
{ {
if (_driver_apdu != NULL) if (_driver_apdu != NULL)
{ {
_driver_apdu->fini(); _driver_apdu->fini(&euicc_driver_interface_apdu);
} }
if (_driver_http != NULL) if (_driver_http != NULL)
{ {
_driver_http->fini(); _driver_http->fini(&euicc_driver_interface_http);
} }
} }

View file

@ -12,5 +12,5 @@ struct euicc_driver
const char *name; const char *name;
int (*init)(void *interface); int (*init)(void *interface);
int (*main)(int argc, char **argv); int (*main)(int argc, char **argv);
void (*fini)(void); void (*fini)(void *interface);
}; };

View file

@ -192,7 +192,7 @@ static int libhttpinterface_main(int argc, char **argv)
return 0; return 0;
} }
static void libhttpinterface_fini(void) static void libhttpinterface_fini(struct euicc_http_interface *ifstruct)
{ {
} }
@ -201,5 +201,5 @@ const struct euicc_driver driver_http_curl = {
.name = "curl", .name = "curl",
.init = (int (*)(void *))libhttpinterface_init, .init = (int (*)(void *))libhttpinterface_init,
.main = libhttpinterface_main, .main = libhttpinterface_main,
.fini = libhttpinterface_fini, .fini = (void (*)(void *))libhttpinterface_fini,
}; };

View file

@ -43,7 +43,7 @@ static int afgets(char **obuf, FILE *fp)
} }
} }
(*obuf)[strcspn(*obuf, "\r\n")] = 0; (*obuf)[strcspn(*obuf, "\n")] = 0;
return 0; return 0;
@ -87,7 +87,7 @@ static int json_print(cJSON *jpayload)
} }
cJSON_Delete(jroot); cJSON_Delete(jroot);
fprintf(stdout, "%s\r\n", jstr); fprintf(stdout, "%s\n", jstr);
fflush(stdout); fflush(stdout);
free(jstr); free(jstr);
@ -272,7 +272,7 @@ static int libhttpinterface_main(int argc, char **argv)
return 0; return 0;
} }
static void libhttpinterface_fini(void) static void libhttpinterface_fini(struct euicc_http_interface *ifstruct)
{ {
} }
@ -281,5 +281,5 @@ const struct euicc_driver driver_http_stdio = {
.name = "stdio", .name = "stdio",
.init = (int (*)(void *))libhttpinterface_init, .init = (int (*)(void *))libhttpinterface_init,
.main = libhttpinterface_main, .main = libhttpinterface_main,
.fini = libhttpinterface_fini, .fini = (void (*)(void *))libhttpinterface_fini,
}; };

View file

@ -16,6 +16,10 @@ if(LPAC_DYNAMIC_LIBEUICC)
endif() endif()
endforeach() endforeach()
set_target_properties(euicc PROPERTIES PUBLIC_HEADER "${ALL_HEADERS}") set_target_properties(euicc PROPERTIES PUBLIC_HEADER "${ALL_HEADERS}")
# Only useful on Windows, and will lead to invalid arguments on ld.gold.
if(WIN32)
set_target_properties(euicc PROPERTIES LINK_FLAGS "-Wl,--export-all-symbols")
endif()
# Install a pkg-config file # Install a pkg-config file
configure_file(libeuicc.pc.in libeuicc.pc @ONLY) configure_file(libeuicc.pc.in libeuicc.pc @ONLY)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libeuicc.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libeuicc.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)

View file

@ -67,7 +67,7 @@ int euicc_base64_decode(unsigned char *bufplain, const char *bufcoded)
nprbytes -= 4; nprbytes -= 4;
} }
/* Note: (nprbytes == 1) would be an error, so just ingore that case */ /* Note: (nprbytes == 1) would be an error, so just ignore that case */
if (nprbytes > 1) if (nprbytes > 1)
{ {
*(bufout++) = *(bufout++) =

View file

@ -313,7 +313,10 @@ int euicc_derutil_convert_long2bin(uint8_t *buffer, uint32_t *buffer_len, long v
{ {
if (value > 0) if (value > 0)
{ {
required_len++; if ((value >> ((i - 1) * 8)) & 0x80)
{
required_len++;
}
} }
break; break;
} }

View file

@ -526,7 +526,7 @@ exit:
return fret; return fret;
} }
int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateServerResponse, struct es10b_authenticate_server_param *param, struct es10b_authenticate_server_param_user *param_user) int es10b_authenticate_server_r(struct euicc_ctx *ctx, uint8_t **transaction_id, uint32_t *transaction_id_len, char **b64_AuthenticateServerResponse, struct es10b_authenticate_server_param *param, struct es10b_authenticate_server_param_user *param_user)
{ {
int fret = 0; int fret = 0;
uint8_t *reqbuf = NULL; uint8_t *reqbuf = NULL;
@ -537,8 +537,10 @@ int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateSe
uint8_t imei[8]; uint8_t imei[8];
uint8_t *serverSigned1 = NULL, *serverSignature1 = NULL, *euiccCiPKIdToBeUsed = NULL, *serverCertificate = NULL; uint8_t *serverSigned1 = NULL, *serverSignature1 = NULL, *euiccCiPKIdToBeUsed = NULL, *serverCertificate = NULL;
int serverSigned1_len, serverSignature1_len, euiccCiPKIdToBeUsed_len, serverCertificate_len; int serverSigned1_len, serverSignature1_len, euiccCiPKIdToBeUsed_len, serverCertificate_len;
struct euicc_derutil_node n_request, n_serverSigned1, n_serverSignature1, n_euiccCiPKIdToBeUsed, n_serverCertificate, n_CtxParams1, n_matchingId, n_deviceInfo, n_tac, n_deviceCapabilities, n_imei; struct euicc_derutil_node n_request, n_serverSigned1, n_transactionId, n_serverSignature1, n_euiccCiPKIdToBeUsed, n_serverCertificate, n_CtxParams1, n_matchingId, n_deviceInfo, n_tac, n_deviceCapabilities, n_imei;
*transaction_id = NULL;
*transaction_id_len = 0;
*b64_AuthenticateServerResponse = NULL; *b64_AuthenticateServerResponse = NULL;
memset(&n_request, 0, sizeof(n_request)); memset(&n_request, 0, sizeof(n_request));
@ -602,6 +604,11 @@ int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateSe
goto err; goto err;
} }
if (euicc_derutil_unpack_find_tag(&n_transactionId, 0x80, n_serverSigned1.value, n_serverSigned1.length) < 0)
{
goto err;
}
if (euicc_derutil_unpack_find_tag(&n_serverSignature1, 0x5F37, serverSignature1, serverSignature1_len) < 0) if (euicc_derutil_unpack_find_tag(&n_serverSignature1, 0x5F37, serverSignature1, serverSignature1_len) < 0)
{ {
goto err; goto err;
@ -617,6 +624,14 @@ int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateSe
goto err; goto err;
} }
*transaction_id_len = n_transactionId.length;
*transaction_id = malloc(n_transactionId.length);
if (!(*transaction_id))
{
goto err;
}
memcpy(*transaction_id, n_transactionId.value, n_transactionId.length);
n_request.tag = 0xBF38; n_request.tag = 0xBF38;
n_request.pack.child = &n_serverSigned1; n_request.pack.child = &n_serverSigned1;
n_serverSigned1.pack.next = &n_serverSignature1; n_serverSigned1.pack.next = &n_serverSignature1;
@ -636,7 +651,7 @@ int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateSe
{ {
int imei_len; int imei_len;
imei_len = euicc_hexutil_gsmbcd2bin(imei, sizeof(imei), param_user->imei); imei_len = euicc_hexutil_gsmbcd2bin(imei, sizeof(imei), param_user->imei, 0);
if (imei_len < 0) if (imei_len < 0)
{ {
goto err; goto err;
@ -704,6 +719,9 @@ int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateSe
err: err:
fret = -1; fret = -1;
free(*transaction_id);
*transaction_id = NULL;
*transaction_id_len = 0;
free(*b64_AuthenticateServerResponse); free(*b64_AuthenticateServerResponse);
*b64_AuthenticateServerResponse = NULL; *b64_AuthenticateServerResponse = NULL;
exit: exit:
@ -724,7 +742,73 @@ exit:
int es10b_cancel_session_r(struct euicc_ctx *ctx, char **b64_CancelSessionResponse, struct es10b_cancel_session_param *param) int es10b_cancel_session_r(struct euicc_ctx *ctx, char **b64_CancelSessionResponse, struct es10b_cancel_session_param *param)
{ {
return -1; int fret = 0;
struct euicc_derutil_node n_request, n_transactionId, n_reason;
uint8_t reason_buf[sizeof(enum es10b_cancel_session_reason)];
uint32_t reason_buf_len = sizeof(reason_buf);
uint32_t reqlen;
uint8_t *respbuf = NULL;
unsigned resplen;
struct euicc_derutil_node tmpnode;
if (euicc_derutil_convert_long2bin(reason_buf, &reason_buf_len, param->reason) < 0)
{
goto err;
}
memset(&n_request, 0, sizeof(n_request));
memset(&n_transactionId, 0, sizeof(n_transactionId));
memset(&n_reason, 0, sizeof(n_reason));
n_request.tag = 0xBF41; // CancelSessionRequest
n_request.pack.child = &n_transactionId;
n_transactionId.tag = 0x80;
n_transactionId.value = (const uint8_t *)param->transactionId;
n_transactionId.length = param->transactionIdLen;
n_transactionId.pack.next = &n_reason;
n_reason.tag = 0x81;
n_reason.value = reason_buf;
n_reason.length = reason_buf_len;
reqlen = sizeof(ctx->apdu._internal.request_buffer.body);
if (euicc_derutil_pack(ctx->apdu._internal.request_buffer.body, &reqlen, &n_request))
{
goto err;
}
if (es10x_command(ctx, &respbuf, &resplen, ctx->apdu._internal.request_buffer.body, reqlen) < 0)
{
goto err;
}
if (euicc_derutil_unpack_find_tag(&tmpnode, n_request.tag, respbuf, resplen))
{
goto err;
}
*b64_CancelSessionResponse = malloc(euicc_base64_encode_len(tmpnode.self.length));
if (!(*b64_CancelSessionResponse))
{
goto err;
}
if (euicc_base64_encode(*b64_CancelSessionResponse, tmpnode.self.ptr, tmpnode.self.length) < 0)
{
goto err;
}
goto exit;
err:
fret = -1;
free(*b64_CancelSessionResponse);
*b64_CancelSessionResponse = NULL;
exit:
free(respbuf);
respbuf = NULL;
return fret;
} }
void es10b_prepare_download_param_free(struct es10b_prepare_download_param *param) void es10b_prepare_download_param_free(struct es10b_prepare_download_param *param)
@ -866,7 +950,7 @@ int es10b_authenticate_server(struct euicc_ctx *ctx, const char *matchingId, con
return -1; return -1;
} }
fret = es10b_authenticate_server_r(ctx, &ctx->http._internal.b64_authenticate_server_response, ctx->http._internal.authenticate_server_param, &param_user); fret = es10b_authenticate_server_r(ctx, &ctx->http._internal.transaction_id_bin, &ctx->http._internal.transaction_id_bin_len, &ctx->http._internal.b64_authenticate_server_response, ctx->http._internal.authenticate_server_param, &param_user);
if (fret < 0) if (fret < 0)
{ {
ctx->http._internal.b64_authenticate_server_response = NULL; ctx->http._internal.b64_authenticate_server_response = NULL;
@ -880,9 +964,39 @@ int es10b_authenticate_server(struct euicc_ctx *ctx, const char *matchingId, con
return fret; return fret;
} }
int es10b_cancel_session(struct euicc_ctx *ctx) int es10b_cancel_session(struct euicc_ctx *ctx, enum es10b_cancel_session_reason reason)
{ {
return -1; int fret;
struct es10b_cancel_session_param param = {
.transactionId = ctx->http._internal.transaction_id_bin,
.transactionIdLen = ctx->http._internal.transaction_id_bin_len,
.reason = reason,
};
if (ctx->http._internal.transaction_id_bin == NULL)
{
return -1;
}
if (ctx->http._internal.transaction_id_bin_len == 0)
{
return -1;
}
if (ctx->http._internal.b64_cancel_session_response)
{
return -1;
}
fret = es10b_cancel_session_r(ctx, &ctx->http._internal.b64_cancel_session_response, &param);
if (fret < 0)
{
ctx->http._internal.b64_cancel_session_response = NULL;
}
return fret;
} }
int es10b_list_notification(struct euicc_ctx *ctx, struct es10b_notification_metadata_list **notificationMetadataList) int es10b_list_notification(struct euicc_ctx *ctx, struct es10b_notification_metadata_list **notificationMetadataList)
@ -1207,3 +1321,196 @@ void es10b_pending_notification_free(struct es10b_pending_notification *PendingN
free(PendingNotification->b64_PendingNotification); free(PendingNotification->b64_PendingNotification);
memset(PendingNotification, 0, sizeof(struct es10b_pending_notification)); memset(PendingNotification, 0, sizeof(struct es10b_pending_notification));
} }
int es10b_get_rat(struct euicc_ctx *ctx, struct es10b_rat **ratList)
{
int fret;
struct euicc_derutil_node n_request = {
.tag = 0xBF43, // GetRatRequest
};
uint32_t reqlen;
uint8_t *respbuf = NULL;
unsigned resplen;
struct es10b_rat *rat_list_wptr = NULL;
struct euicc_derutil_node tmpnode, tmpchildnode, n_profile;
*ratList = NULL;
reqlen = sizeof(ctx->apdu._internal.request_buffer.body);
if (euicc_derutil_pack(ctx->apdu._internal.request_buffer.body, &reqlen, &n_request))
{
goto err;
}
if (es10x_command(ctx, &respbuf, &resplen, ctx->apdu._internal.request_buffer.body, reqlen) < 0)
{
goto err;
}
if (resplen == 0)
{
goto err;
}
// GetRatResponse
if (euicc_derutil_unpack_find_tag(&tmpnode, 0xBF43, respbuf, resplen) < 0)
{
goto err;
}
// RulesAuthorisationTable
if (euicc_derutil_unpack_find_tag(&tmpnode, 0xA0, tmpnode.value, tmpnode.length) < 0)
{
goto err;
}
n_profile.self.ptr = tmpnode.value;
n_profile.self.length = 0;
// ProfilePolicyAuthorisationRule
while (euicc_derutil_unpack_next(&n_profile, &n_profile, tmpnode.value, tmpnode.length) == 0)
{
struct es10b_rat *rat;
tmpchildnode.self.ptr = n_profile.value;
tmpchildnode.self.length = 0;
rat = malloc(sizeof(struct es10b_rat));
if (!rat)
{
goto err;
}
memset(rat, 0, sizeof(*rat));
while (euicc_derutil_unpack_next(&tmpchildnode, &tmpchildnode, n_profile.value, n_profile.length) == 0)
{
switch (tmpchildnode.tag)
{
case 0x80: // ppr ids
{
static const char *desc[] = {"pprUpdateControl", "ppr1", "ppr2", "ppr3", NULL};
if (euicc_derutil_convert_bin2bits_str(&rat->pprIds, tmpchildnode.value, tmpchildnode.length, desc))
{
goto err;
}
}
break;
case 0xA1: // allowed operators
{
struct euicc_derutil_node n_allowed_operator, n_operator;
struct es10b_operation_id *operations_wptr = NULL;
struct es10b_operation_id *p;
n_allowed_operator.self.ptr = tmpchildnode.value;
n_allowed_operator.self.length = 0;
while (euicc_derutil_unpack_next(&n_allowed_operator, &n_allowed_operator, tmpchildnode.value, tmpchildnode.length) == 0)
{
p = malloc(sizeof(struct es10b_operation_id));
if (!p)
{
goto err;
}
memset(p, 0, sizeof(*p));
n_operator.self.ptr = n_allowed_operator.value;
n_operator.self.length = 0;
while (euicc_derutil_unpack_next(&n_operator, &n_operator, n_allowed_operator.value, n_allowed_operator.length) == 0)
{
if (n_operator.length == 0)
{
continue;
}
switch (n_operator.tag)
{
case 0x80: // mcc_mnc
p->plmn = malloc((n_operator.length * 2) + 1);
euicc_hexutil_bin2hex(p->plmn, (n_operator.length * 2) + 1, n_operator.value, n_operator.length);
break;
case 0x81: // gid1
p->gid1 = malloc((n_operator.length * 2) + 1);
euicc_hexutil_bin2hex(p->gid1, (n_operator.length * 2) + 1, n_operator.value, n_operator.length);
break;
case 0x82: // gid2
p->gid2 = malloc((n_operator.length * 2) + 1);
euicc_hexutil_bin2hex(p->gid2, (n_operator.length * 2) + 1, n_operator.value, n_operator.length);
break;
}
}
if (operations_wptr == NULL)
{
operations_wptr = p;
}
else
{
operations_wptr->next = p;
}
}
rat->allowedOperators = operations_wptr;
}
break;
case 0x82: // ppr flags
{
static const char *desc[] = {"consentRequired", NULL};
if (euicc_derutil_convert_bin2bits_str(&rat->pprFlags, tmpchildnode.value, tmpchildnode.length, desc))
{
goto err;
}
}
break;
}
}
if (*ratList == NULL)
{
*ratList = rat;
}
else
{
rat_list_wptr->next = rat;
}
rat_list_wptr = rat;
}
fret = 0;
goto exit;
err:
fret = -1;
es10b_rat_list_free_all(*ratList);
*ratList = NULL;
exit:
free(respbuf);
respbuf = NULL;
return fret;
}
void es10b_rat_list_free_all(struct es10b_rat *ratList)
{
struct es10b_rat *next_rat;
struct es10b_operation_id *next_operation_id;
while (ratList)
{
next_rat = ratList->next;
free(ratList->pprIds);
while (ratList->allowedOperators)
{
next_operation_id = ratList->allowedOperators->next;
free(ratList->allowedOperators->plmn);
free(ratList->allowedOperators->gid1);
free(ratList->allowedOperators->gid2);
free(ratList->allowedOperators);
ratList->allowedOperators = next_operation_id;
}
free(ratList->pprFlags);
free(ratList);
ratList = next_rat;
}
}

View file

@ -108,13 +108,32 @@ struct es10b_cancel_session_param
{ {
const uint8_t *transactionId; const uint8_t *transactionId;
uint8_t transactionIdLen; uint8_t transactionIdLen;
enum es10b_cancel_session_reason reason;
};
struct es10b_rat
{
const char **pprIds;
struct es10b_operation_id *allowedOperators;
const char **pprFlags;
struct es10b_rat *next;
};
struct es10b_operation_id
{
char *plmn;
char *gid1;
char *gid2;
struct es10b_operation_id *next;
}; };
int es10b_prepare_download_r(struct euicc_ctx *ctx, char **b64_PrepareDownloadResponse, struct es10b_prepare_download_param *param, struct es10b_prepare_download_param_user *param_user); int es10b_prepare_download_r(struct euicc_ctx *ctx, char **b64_PrepareDownloadResponse, struct es10b_prepare_download_param *param, struct es10b_prepare_download_param_user *param_user);
int es10b_load_bound_profile_package_r(struct euicc_ctx *ctx, struct es10b_load_bound_profile_package_result *result, const char *b64_BoundProfilePackage); int es10b_load_bound_profile_package_r(struct euicc_ctx *ctx, struct es10b_load_bound_profile_package_result *result, const char *b64_BoundProfilePackage);
int es10b_get_euicc_challenge_r(struct euicc_ctx *ctx, char **b64_euiccChallenge); int es10b_get_euicc_challenge_r(struct euicc_ctx *ctx, char **b64_euiccChallenge);
int es10b_get_euicc_info_r(struct euicc_ctx *ctx, char **b64_EUICCInfo1); int es10b_get_euicc_info_r(struct euicc_ctx *ctx, char **b64_EUICCInfo1);
int es10b_authenticate_server_r(struct euicc_ctx *ctx, char **b64_AuthenticateServerResponse, struct es10b_authenticate_server_param *param, struct es10b_authenticate_server_param_user *param_user); int es10b_authenticate_server_r(struct euicc_ctx *ctx, uint8_t **transaction_id, uint32_t *transaction_id_len, char **b64_AuthenticateServerResponse, struct es10b_authenticate_server_param *param, struct es10b_authenticate_server_param_user *param_user);
int es10b_cancel_session_r(struct euicc_ctx *ctx, char **b64_CancelSessionResponse, struct es10b_cancel_session_param *param); int es10b_cancel_session_r(struct euicc_ctx *ctx, char **b64_CancelSessionResponse, struct es10b_cancel_session_param *param);
void es10b_prepare_download_param_free(struct es10b_prepare_download_param *param); void es10b_prepare_download_param_free(struct es10b_prepare_download_param *param);
@ -124,7 +143,7 @@ int es10b_prepare_download(struct euicc_ctx *ctx, const char *confirmationCode);
int es10b_load_bound_profile_package(struct euicc_ctx *ctx, struct es10b_load_bound_profile_package_result *result); int es10b_load_bound_profile_package(struct euicc_ctx *ctx, struct es10b_load_bound_profile_package_result *result);
int es10b_get_euicc_challenge_and_info(struct euicc_ctx *ctx); int es10b_get_euicc_challenge_and_info(struct euicc_ctx *ctx);
int es10b_authenticate_server(struct euicc_ctx *ctx, const char *matchingId, const char *imei); int es10b_authenticate_server(struct euicc_ctx *ctx, const char *matchingId, const char *imei);
int es10b_cancel_session(struct euicc_ctx *ctx); int es10b_cancel_session(struct euicc_ctx *ctx, enum es10b_cancel_session_reason reason);
int es10b_list_notification(struct euicc_ctx *ctx, struct es10b_notification_metadata_list **notificationMetadataList); int es10b_list_notification(struct euicc_ctx *ctx, struct es10b_notification_metadata_list **notificationMetadataList);
int es10b_retrieve_notifications_list(struct euicc_ctx *ctx, struct es10b_pending_notification *PendingNotification, unsigned long seqNumber); int es10b_retrieve_notifications_list(struct euicc_ctx *ctx, struct es10b_pending_notification *PendingNotification, unsigned long seqNumber);
@ -132,3 +151,6 @@ int es10b_remove_notification_from_list(struct euicc_ctx *ctx, unsigned long seq
void es10b_notification_metadata_list_free_all(struct es10b_notification_metadata_list *notificationMetadataList); void es10b_notification_metadata_list_free_all(struct es10b_notification_metadata_list *notificationMetadataList);
void es10b_pending_notification_free(struct es10b_pending_notification *PendingNotification); void es10b_pending_notification_free(struct es10b_pending_notification *PendingNotification);
int es10b_get_rat(struct euicc_ctx *ctx, struct es10b_rat **ratList);
void es10b_rat_list_free_all(struct es10b_rat *ratList);

View file

@ -222,7 +222,7 @@ static int es10c_enable_disable_delete_profile(struct euicc_ctx *ctx, uint16_t o
} }
else else
{ {
if ((id_len = euicc_hexutil_gsmbcd2bin(id, sizeof(id), str_id)) < 0) if ((id_len = euicc_hexutil_gsmbcd2bin(id, sizeof(id), str_id, 10)) < 0)
{ {
return -1; return -1;
} }
@ -447,7 +447,7 @@ int es10c_set_nickname(struct euicc_ctx *ctx, const char *iccid, const char *pro
memset(&n_iccid, 0, sizeof(n_iccid)); memset(&n_iccid, 0, sizeof(n_iccid));
memset(&n_profileNickname, 0, sizeof(n_profileNickname)); memset(&n_profileNickname, 0, sizeof(n_profileNickname));
if (euicc_hexutil_gsmbcd2bin(asn1iccid, sizeof(asn1iccid), iccid) < 0) if (euicc_hexutil_gsmbcd2bin(asn1iccid, sizeof(asn1iccid), iccid, 10) < 0)
{ {
goto err; goto err;
} }

View file

@ -84,7 +84,7 @@ int es10c_ex_get_euiccinfo2(struct euicc_ctx *ctx, struct es10c_ex_euiccinfo2 *e
break; break;
case 0x85: // uiccCapability case 0x85: // uiccCapability
{ {
static const char *desc[] = {"contactlessSupport", "usimSupport", "isimSupport", "csimSupport", "akaMilenage", "akaCave", "akaTuak128", "akaTuak256", "rfu1", "rfu2", "gbaAuthenUsim", "gbaAuthenISim", "mbmsAuthenUsim", "eapClient", "javacard", "multos", "multipleUsimSupport", "multipleIsimSupport", "multipleCsimSupport"}; static const char *desc[] = {"contactlessSupport", "usimSupport", "isimSupport", "csimSupport", "akaMilenage", "akaCave", "akaTuak128", "akaTuak256", "rfu1", "rfu2", "gbaAuthenUsim", "gbaAuthenISim", "mbmsAuthenUsim", "eapClient", "javacard", "multos", "multipleUsimSupport", "multipleIsimSupport", "multipleCsimSupport", NULL};
if (euicc_derutil_convert_bin2bits_str(&euiccinfo2->uiccCapability, tmpnode.value, tmpnode.length, desc)) if (euicc_derutil_convert_bin2bits_str(&euiccinfo2->uiccCapability, tmpnode.value, tmpnode.length, desc))
{ {
@ -100,7 +100,7 @@ int es10c_ex_get_euiccinfo2(struct euicc_ctx *ctx, struct es10c_ex_euiccinfo2 *e
break; break;
case 0x88: // rspCapability case 0x88: // rspCapability
{ {
static const char *desc[] = {"additionalProfile", "crlSupport", "rpmSupport", "testProfileSupport"}; static const char *desc[] = {"additionalProfile", "crlSupport", "rpmSupport", "testProfileSupport", NULL};
if (euicc_derutil_convert_bin2bits_str(&euiccinfo2->rspCapability, tmpnode.value, tmpnode.length, desc)) if (euicc_derutil_convert_bin2bits_str(&euiccinfo2->rspCapability, tmpnode.value, tmpnode.length, desc))
{ {
@ -202,7 +202,7 @@ int es10c_ex_get_euiccinfo2(struct euicc_ctx *ctx, struct es10c_ex_euiccinfo2 *e
break; break;
case 0x99: // forbiddenProfilePolicyRules case 0x99: // forbiddenProfilePolicyRules
{ {
static const char *desc[] = {"pprUpdateControl", "ppr1", "ppr2", "ppr3"}; static const char *desc[] = {"pprUpdateControl", "ppr1", "ppr2", "ppr3", NULL};
if (euicc_derutil_convert_bin2bits_str(&euiccinfo2->forbiddenProfilePolicyRules, tmpnode.value, tmpnode.length, desc)) if (euicc_derutil_convert_bin2bits_str(&euiccinfo2->forbiddenProfilePolicyRules, tmpnode.value, tmpnode.length, desc))
{ {

158
euicc/es8p.c Normal file
View file

@ -0,0 +1,158 @@
#include "es8p.h"
#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "derutil.h"
#include "hexutil.h"
#include "base64.h"
int es8p_metadata_parse(struct es8p_metadata **stru_metadata, const char *b64_Metadata)
{
int ret;
uint8_t *metadata = NULL;
int metadata_len = 0;
struct euicc_derutil_node n_metadata, n_iter;
struct es8p_metadata *p = NULL;
*stru_metadata = NULL;
memset(&n_metadata, 0x00, sizeof(n_metadata));
memset(&n_iter, 0x00, sizeof(n_iter));
metadata = malloc(euicc_base64_decode_len(b64_Metadata));
if (!metadata)
{
goto err;
}
if ((metadata_len = euicc_base64_decode(metadata, b64_Metadata)) < 0)
{
goto err;
}
if (euicc_derutil_unpack_find_tag(&n_metadata, 0xBF25, metadata, metadata_len) < 0)
{
goto err;
}
if (!(p = malloc(sizeof(struct es8p_metadata))))
{
goto err;
}
memset(p, 0, sizeof(*p));
n_iter.self.ptr = n_metadata.value;
n_iter.self.length = 0;
p->profileClass = ES10C_PROFILE_CLASS_NULL;
p->iconType = ES10C_ICON_TYPE_NULL;
while (euicc_derutil_unpack_next(&n_iter, &n_iter, n_metadata.value, n_metadata.length) == 0)
{
int tmplong;
switch (n_iter.tag)
{
case 0x5A:
euicc_hexutil_bin2gsmbcd(p->iccid, sizeof(p->iccid), n_iter.value, n_iter.length);
break;
case 0x91:
p->serviceProviderName = malloc(n_iter.length + 1);
if (p->serviceProviderName)
{
memcpy(p->serviceProviderName, n_iter.value, n_iter.length);
p->serviceProviderName[n_iter.length] = '\0';
}
break;
case 0x92:
p->profileName = malloc(n_iter.length + 1);
if (p->profileName)
{
memcpy(p->profileName, n_iter.value, n_iter.length);
p->profileName[n_iter.length] = '\0';
}
break;
case 0x93:
tmplong = euicc_derutil_convert_bin2long(n_iter.value, n_iter.length);
switch (tmplong)
{
case ES10C_ICON_TYPE_JPEG:
case ES10C_ICON_TYPE_PNG:
p->iconType = tmplong;
break;
default:
p->iconType = ES10C_ICON_TYPE_UNDEFINED;
break;
}
break;
case 0x94:
p->icon = malloc(euicc_base64_encode_len(n_iter.length));
if (p->icon)
{
euicc_base64_encode(p->icon, n_iter.value, n_iter.length);
}
break;
case 0x95:
tmplong = euicc_derutil_convert_bin2long(n_iter.value, n_iter.length);
switch (tmplong)
{
case ES10C_PROFILE_CLASS_TEST:
case ES10C_PROFILE_CLASS_PROVISIONING:
case ES10C_PROFILE_CLASS_OPERATIONAL:
p->profileClass = tmplong;
break;
default:
p->profileClass = ES10C_PROFILE_CLASS_UNDEFINED;
break;
}
break;
case 0xB6:
case 0xB7:
case 0x99:
// fprintf(stderr, "\n[PLEASE REPORT][TODO][TAG %02X]: ", n_iter.tag);
// for (uint32_t i = 0; i < n_iter.self.length; i++)
// {
// fprintf(stderr, "%02X ", n_iter.self.ptr[i]);
// }
// fprintf(stderr, "\n");
break;
}
}
*stru_metadata = p;
ret = 0;
goto exit;
err:
ret = -1;
free(*stru_metadata);
*stru_metadata = NULL;
free(p);
p = NULL;
exit:
free(metadata);
metadata = NULL;
return ret;
}
void es8p_metadata_free(struct es8p_metadata **stru_metadata)
{
struct es8p_metadata *p = *stru_metadata;
if (p == NULL)
{
return;
}
free(p->serviceProviderName);
free(p->profileName);
free(p->icon);
free(p);
*stru_metadata = NULL;
}

32
euicc/es8p.h Normal file
View file

@ -0,0 +1,32 @@
#pragma once
#include "euicc.h"
#include "es10c.h"
struct es8p_metadata
{
char iccid[(10 * 2) + 1];
char *serviceProviderName;
char *profileName;
enum es10c_icon_type iconType;
char *icon;
enum es10c_profile_class profileClass;
struct
{
char **profileManagementOperation;
char *notificationAddress;
} notificationConfigurationInfo;
struct
{
char *mccmnc;
char *gid1;
char *gid2;
} profileOwner;
struct
{
char *dpOid;
} dpProprietaryData;
char **profilePolicyRules;
};
int es8p_metadata_parse(struct es8p_metadata **metadata, const char *b64_Metadata);
void es8p_metadata_free(struct es8p_metadata **stru_metadata);

View file

@ -1,4 +1,5 @@
#include "es9p.h" #include "es9p.h"
#include "es9p_errors.h"
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
@ -13,6 +14,23 @@ static const char *lpa_header[] = {
NULL, NULL,
}; };
static void es9p_base64_trim(char *str)
{
char *p = str;
while (*p)
{
if (*p == '\n' || *p == '\r' || *p == ' ' || *p == '\t')
{
memmove(p, p + 1, strlen(p));
}
else
{
p++;
}
}
}
static int es9p_trans_ex(struct euicc_ctx *ctx, const char *url, const char *url_postfix, uint32_t *rcode, char **str_rx, const char *str_tx) static int es9p_trans_ex(struct euicc_ctx *ctx, const char *url, const char *url_postfix, uint32_t *rcode, char **str_rx, const char *str_tx)
{ {
int fret = 0; int fret = 0;
@ -202,7 +220,15 @@ static int es9p_trans_json(struct euicc_ctx *ctx, const char *smdp, const char *
} }
else else
{ {
snprintf(ctx->http.status.message, sizeof(ctx->http.status.message), "subject-code: %s, reason-code: %s", ctx->http.status.subjectCode, ctx->http.status.reasonCode); const char* message = es9p_error_message(ctx->http.status.subjectCode, ctx->http.status.reasonCode);
if (message != NULL)
{
strncpy(ctx->http.status.message, message, sizeof(ctx->http.status.message));
}
else
{
snprintf(ctx->http.status.message, sizeof(ctx->http.status.message), "subject-code: %s, reason-code: %s", ctx->http.status.subjectCode, ctx->http.status.reasonCode);
}
} }
} }
@ -258,48 +284,80 @@ int es9p_initiate_authentication_r(struct euicc_ctx *ctx, char **transaction_id,
const char *idata[] = {ctx->http.server_address, b64_euicc_challenge, b64_euicc_info_1, NULL}; const char *idata[] = {ctx->http.server_address, b64_euicc_challenge, b64_euicc_info_1, NULL};
const char *okey[] = {"transactionId", "serverSigned1", "serverSignature1", "euiccCiPKIdToBeUsed", "serverCertificate", NULL}; const char *okey[] = {"transactionId", "serverSigned1", "serverSignature1", "euiccCiPKIdToBeUsed", "serverCertificate", NULL};
const char oobj[] = {0, 0, 0, 0, 0}; const char oobj[] = {0, 0, 0, 0, 0};
void **optr[] = {(void **)&ctx->http._internal.transaction_id, (void **)&resp->b64_serverSigned1, (void **)&resp->b64_serverSignature1, (void **)&resp->b64_euiccCiPKIdToBeUsed, (void **)&resp->b64_serverCertificate, NULL}; void **optr[] = {(void **)transaction_id, (void **)&resp->b64_serverSigned1, (void **)&resp->b64_serverSignature1, (void **)&resp->b64_euiccCiPKIdToBeUsed, (void **)&resp->b64_serverCertificate, NULL};
return es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/initiateAuthentication", ikey, idata, okey, oobj, optr); if (es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/initiateAuthentication", ikey, idata, okey, oobj, optr))
{
return -1;
}
es9p_base64_trim(resp->b64_serverSigned1);
es9p_base64_trim(resp->b64_serverSignature1);
es9p_base64_trim(resp->b64_euiccCiPKIdToBeUsed);
es9p_base64_trim(resp->b64_serverCertificate);
return 0;
} }
int es9p_get_bound_profile_package_r(struct euicc_ctx *ctx, char **b64_bound_profile_package, const char *server_address, const char *transction_id, const char *b64_prepare_download_response) int es9p_get_bound_profile_package_r(struct euicc_ctx *ctx, char **b64_bound_profile_package, const char *server_address, const char *transaction_id, const char *b64_prepare_download_response)
{ {
const char *ikey[] = {"transactionId", "prepareDownloadResponse", NULL}; const char *ikey[] = {"transactionId", "prepareDownloadResponse", NULL};
const char *idata[] = {ctx->http._internal.transaction_id, b64_prepare_download_response, NULL}; const char *idata[] = {transaction_id, b64_prepare_download_response, NULL};
const char *okey[] = {"boundProfilePackage", NULL}; const char *okey[] = {"boundProfilePackage", NULL};
const char oobj[] = {0}; const char oobj[] = {0};
void **optr[] = {(void **)b64_bound_profile_package, NULL}; void **optr[] = {(void **)b64_bound_profile_package, NULL};
return es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/getBoundProfilePackage", ikey, idata, okey, oobj, optr); if (es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/getBoundProfilePackage", ikey, idata, okey, oobj, optr))
{
return -1;
}
es9p_base64_trim(*b64_bound_profile_package);
return 0;
} }
int es9p_authenticate_client_r(struct euicc_ctx *ctx, struct es10b_prepare_download_param *resp, const char *server_address, const char *transction_id, const char *b64_authenticate_server_response) int es9p_authenticate_client_r(struct euicc_ctx *ctx, struct es10b_prepare_download_param *resp, const char *server_address, const char *transaction_id, const char *b64_authenticate_server_response)
{ {
const char *ikey[] = {"transactionId", "authenticateServerResponse", NULL}; const char *ikey[] = {"transactionId", "authenticateServerResponse", NULL};
const char *idata[] = {ctx->http._internal.transaction_id, b64_authenticate_server_response, NULL}; const char *idata[] = {transaction_id, b64_authenticate_server_response, NULL};
const char *okey[] = {"profileMetadata", "smdpSigned2", "smdpSignature2", "smdpCertificate", NULL}; const char *okey[] = {"profileMetadata", "smdpSigned2", "smdpSignature2", "smdpCertificate", NULL};
const char oobj[] = {0, 0, 0, 0}; const char oobj[] = {0, 0, 0, 0};
void **optr[] = {(void **)&resp->b64_profileMetadata, (void **)&resp->b64_smdpSigned2, (void **)&resp->b64_smdpSignature2, (void **)&resp->b64_smdpCertificate, NULL}; void **optr[] = {(void **)&resp->b64_profileMetadata, (void **)&resp->b64_smdpSigned2, (void **)&resp->b64_smdpSignature2, (void **)&resp->b64_smdpCertificate, NULL};
return es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/authenticateClient", ikey, idata, okey, oobj, optr); if (es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/authenticateClient", ikey, idata, okey, oobj, optr))
{
return -1;
}
es9p_base64_trim(resp->b64_profileMetadata);
es9p_base64_trim(resp->b64_smdpSigned2);
es9p_base64_trim(resp->b64_smdpSignature2);
es9p_base64_trim(resp->b64_smdpCertificate);
return 0;
} }
int es9p_cancel_session_r(struct euicc_ctx *ctx, const char *server_address, const char *transction_id, const char *b64_cancel_session_response) int es9p_cancel_session_r(struct euicc_ctx *ctx, const char *server_address, const char *transaction_id, const char *b64_cancel_session_response)
{ {
const char *ikey[] = {"transactionId", "cancelSessionResponse", NULL}; const char *ikey[] = {"transactionId", "cancelSessionResponse", NULL};
const char *idata[] = {ctx->http._internal.transaction_id, b64_cancel_session_response, NULL}; const char *idata[] = {transaction_id, b64_cancel_session_response, NULL};
return es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/cancelSession", ikey, idata, NULL, NULL, NULL); if (es9p_trans_json(ctx, ctx->http.server_address, "/gsma/rsp2/es9plus/cancelSession", ikey, idata, NULL, NULL, NULL))
{
return -1;
}
return 0;
} }
int es11_authenticate_client_r(struct euicc_ctx *ctx, char ***smdp_list, const char *server_address, const char *transction_id, const char *b64_authenticate_server_response) int es11_authenticate_client_r(struct euicc_ctx *ctx, char ***smdp_list, const char *server_address, const char *transaction_id, const char *b64_authenticate_server_response)
{ {
int fret = 0; int fret = 0;
cJSON *j_eventEntries = NULL; cJSON *j_eventEntries = NULL;
int j_eventEntries_size = 0; int j_eventEntries_size = 0;
const char *ikey[] = {"transactionId", "authenticateServerResponse", NULL}; const char *ikey[] = {"transactionId", "authenticateServerResponse", NULL};
const char *idata[] = {ctx->http._internal.transaction_id, b64_authenticate_server_response, NULL}; const char *idata[] = {transaction_id, b64_authenticate_server_response, NULL};
const char *okey[] = {"eventEntries", NULL}; const char *okey[] = {"eventEntries", NULL};
const char oobj[] = {1}; const char oobj[] = {1};
void **optr[] = {(void **)&j_eventEntries, NULL}; void **optr[] = {(void **)&j_eventEntries, NULL};
@ -382,7 +440,7 @@ int es9p_initiate_authentication(struct euicc_ctx *ctx)
return -1; return -1;
} }
fret = es9p_initiate_authentication_r(ctx, &ctx->http._internal.transaction_id, ctx->http._internal.authenticate_server_param, ctx->http.server_address, ctx->http._internal.b64_euicc_challenge, ctx->http._internal.b64_euicc_info_1); fret = es9p_initiate_authentication_r(ctx, &ctx->http._internal.transaction_id_http, ctx->http._internal.authenticate_server_param, ctx->http.server_address, ctx->http._internal.b64_euicc_challenge, ctx->http._internal.b64_euicc_info_1);
if (fret < 0) if (fret < 0)
{ {
free(ctx->http._internal.authenticate_server_param); free(ctx->http._internal.authenticate_server_param);
@ -413,7 +471,7 @@ int es9p_get_bound_profile_package(struct euicc_ctx *ctx)
return -1; return -1;
} }
fret = es9p_get_bound_profile_package_r(ctx, &ctx->http._internal.b64_bound_profile_package, ctx->http.server_address, ctx->http._internal.transaction_id, ctx->http._internal.b64_prepare_download_response); fret = es9p_get_bound_profile_package_r(ctx, &ctx->http._internal.b64_bound_profile_package, ctx->http.server_address, ctx->http._internal.transaction_id_http, ctx->http._internal.b64_prepare_download_response);
if (fret < 0) if (fret < 0)
{ {
free(ctx->http._internal.b64_bound_profile_package); free(ctx->http._internal.b64_bound_profile_package);
@ -447,7 +505,7 @@ int es9p_authenticate_client(struct euicc_ctx *ctx)
return -1; return -1;
} }
fret = es9p_authenticate_client_r(ctx, ctx->http._internal.prepare_download_param, ctx->http.server_address, ctx->http._internal.transaction_id, ctx->http._internal.b64_authenticate_server_response); fret = es9p_authenticate_client_r(ctx, ctx->http._internal.prepare_download_param, ctx->http.server_address, ctx->http._internal.transaction_id_http, ctx->http._internal.b64_authenticate_server_response);
if (fret < 0) if (fret < 0)
{ {
free(ctx->http._internal.prepare_download_param); free(ctx->http._internal.prepare_download_param);
@ -463,7 +521,23 @@ int es9p_authenticate_client(struct euicc_ctx *ctx)
int es9p_cancel_session(struct euicc_ctx *ctx) int es9p_cancel_session(struct euicc_ctx *ctx)
{ {
return -1; int fret;
if (ctx->http._internal.b64_cancel_session_response == NULL)
{
return -1;
}
fret = es9p_cancel_session_r(ctx, ctx->http.server_address, ctx->http._internal.transaction_id_http, ctx->http._internal.b64_cancel_session_response);
if (fret < 0)
{
return fret;
}
free(ctx->http._internal.b64_cancel_session_response);
ctx->http._internal.b64_cancel_session_response = NULL;
return fret;
} }
int es11_authenticate_client(struct euicc_ctx *ctx, char ***smdp_list) int es11_authenticate_client(struct euicc_ctx *ctx, char ***smdp_list)
@ -475,7 +549,7 @@ int es11_authenticate_client(struct euicc_ctx *ctx, char ***smdp_list)
return -1; return -1;
} }
fret = es11_authenticate_client_r(ctx, smdp_list, ctx->http.server_address, ctx->http._internal.transaction_id, ctx->http._internal.b64_authenticate_server_response); fret = es11_authenticate_client_r(ctx, smdp_list, ctx->http.server_address, ctx->http._internal.transaction_id_http, ctx->http._internal.b64_authenticate_server_response);
if (fret < 0) if (fret < 0)
{ {
return fret; return fret;

View file

@ -4,16 +4,16 @@
#include "es10b.h" #include "es10b.h"
int es9p_initiate_authentication_r(struct euicc_ctx *ctx, char **transaction_id, struct es10b_authenticate_server_param *resp, const char *server_address, const char *b64_euicc_challenge, const char *b64_euicc_info_1); int es9p_initiate_authentication_r(struct euicc_ctx *ctx, char **transaction_id, struct es10b_authenticate_server_param *resp, const char *server_address, const char *b64_euicc_challenge, const char *b64_euicc_info_1);
int es9p_get_bound_profile_package_r(struct euicc_ctx *ctx, char **b64_bound_profile_package, const char *server_address, const char *transction_id, const char *b64_prepare_download_response); int es9p_get_bound_profile_package_r(struct euicc_ctx *ctx, char **b64_bound_profile_package, const char *server_address, const char *transaction_id, const char *b64_prepare_download_response);
int es9p_authenticate_client_r(struct euicc_ctx *ctx, struct es10b_prepare_download_param *resp, const char *server_address, const char *transction_id, const char *b64_authenticate_server_response); int es9p_authenticate_client_r(struct euicc_ctx *ctx, struct es10b_prepare_download_param *resp, const char *server_address, const char *transaction_id, const char *b64_authenticate_server_response);
int es9p_cancel_session_r(struct euicc_ctx *ctx, const char *server_address, const char *transction_id, const char *b64_cancel_session_response); int es9p_cancel_session_r(struct euicc_ctx *ctx, const char *server_address, const char *transaction_id, const char *b64_cancel_session_response);
int es9p_initiate_authentication(struct euicc_ctx *ctx); int es9p_initiate_authentication(struct euicc_ctx *ctx);
int es9p_get_bound_profile_package(struct euicc_ctx *ctx); int es9p_get_bound_profile_package(struct euicc_ctx *ctx);
int es9p_authenticate_client(struct euicc_ctx *ctx); int es9p_authenticate_client(struct euicc_ctx *ctx);
int es9p_cancel_session(struct euicc_ctx *ctx); int es9p_cancel_session(struct euicc_ctx *ctx);
int es11_authenticate_client_r(struct euicc_ctx *ctx, char ***smdp_list, const char *server_address, const char *transction_id, const char *b64_authenticate_server_response); int es11_authenticate_client_r(struct euicc_ctx *ctx, char ***smdp_list, const char *server_address, const char *transaction_id, const char *b64_authenticate_server_response);
int es11_authenticate_client(struct euicc_ctx *ctx, char ***smdp_list); int es11_authenticate_client(struct euicc_ctx *ctx, char ***smdp_list);
int es9p_handle_notification(struct euicc_ctx *ctx, const char *b64_PendingNotification); int es9p_handle_notification(struct euicc_ctx *ctx, const char *b64_PendingNotification);

69
euicc/es9p_errors.c Normal file
View file

@ -0,0 +1,69 @@
#include <string.h>
#include "es9p_errors.h"
struct es9p_error {
const char *subject_code;
const char *reason_code;
const char *description;
};
static const struct es9p_error es9p_errors[] = {
{"8.1", "4.8", "eUICC does not have sufficient space for this Profile"},
{"8.1", "6.1", "eUICC signature is invalid or serverChallenge is invalid"},
{"8.1.1", "2.2", "Indicates that the EID is missing in the context of this order (SM-DS address provided or MatchingID value is empty)"},
{"8.1.1", "3.1", "Indicates that a different EID is already associated with this ICCID"},
{"8.1.1", "3.8", "EID doesn't match the expected value"},
{"8.1.2", "6.1", "EUM Certificate is invalid"},
{"8.1.2", "6.3", "EUM Certificate has expired"},
{"8.1.3", "6.1", "eUICC Certificate is invalid"},
{"8.1.3", "6.3", "eUICC Certificate has expired"},
{"8.2", "1.2", "Profile has not yet been released"},
{"8.2", "3.7", "BPP is not available for a new binding"},
{"8.2.1", "1.2", "Indicates that the function caller is not allowed to perform this function on the target Profile"},
{"8.2.1", "3.1", "Indicates that a different EID is associated with this ICCID"},
{"8.2.1", "3.3", "Indicates that the Profile identified by the provided ICCID is not available"},
{"8.2.1", "3.5", "Indicates that the target Profile cannot be released"},
{"8.2.1", "3.9", "Indicates that the Profile Type identified by this Profile Type is unknown to the SM-DP+"},
{"8.2.5", "1.2", "Indicates that the function caller is not allowed to perform this function on the Profile Type"},
{"8.2.5", "3.7", "No more Profile available for the requested Profile Type"},
{"8.2.5", "3.8", "Indicates that the Profile Type identified by this Profile Type is not aligned with the Profile Type of Profile identified by the ICCID"},
{"8.2.5", "3.9", "Indicates that the Profile Type identified by this Profile Type is unknown to the SM-DP+"},
{"8.2.5", "4.3", "No eligible Profile for this eUICC/Device"},
{"8.2.6", "3.1", "Indicates that a different MatchingID is associated with this ICCID"},
{"8.2.6", "3.3", "Conflicting MatchingID value"},
{"8.2.6", "3.8", "MatchingID (AC_Token or EventID) is refused"},
{"8.2.7", "2.2", "Confirmation Code is missing"},
{"8.2.7", "3.8", "Confirmation Code is refused"},
{"8.2.7", "6.4", "The maximum number of retries for the Confirmation Code has been exceeded"},
{"8.8", "3.1", "The provided SM-DP+ OID is invalid"},
{"8.8.1", "3.8", "Invalid SM-DP+ Address"},
{"8.8.2", "3.1", "None of the proposed Public Key Identifiers is supported by the SM-DP+"},
{"8.8.3", "3.1", "The Specification Version Number indicated by the eUICC is not supported by the SM-DP+"},
{"8.8.4", "3.7", "The SM-DP+ has no CERT.DPauth.ECDSA signed by one of the CI Public Key supported by the eUICC"},
{"8.8.5", "4.1", "The Download order has expired"},
{"8.8.5", "6.4", "The maximum number of retries for the Profile download order has been exceeded"},
{"8.9", "4.2", "Root SM-DS has raised an error"},
{"8.9", "5.1", "Root SM-DS was unavailable"},
{"8.9.1", "3.8", "Invalid SM-DS Address"},
{"8.9.2", "3.1", "None of the proposed Public Key Identifiers is supported by the SM-DS"},
{"8.9.3", "3.1", "The Specification Version Number indicated by the eUICC is not supported by the SM-DS"},
{"8.9.4", "3.7", "The SM-DS has no CERT.DS.ECDSA signed by one of the GSMA CI Public Key supported by the eUICC"},
{"8.9.5", "3.3", "The Event Record already exist in the SM-DS (EventID duplicated)"},
{"8.9.5", "3.9", "No Event identified by the Event ID for the EID exists"},
{"8.10.1", "3.9", "The RSP session identified by the TransactionID is unknown"},
{"8.11.1", "3.9", "Unknown CI Public Key. The CI used by the EUM Certificate is not a trusted root."},
};
const char *es9p_error_message(const char *subject_code, const char *reason_code)
{
struct es9p_error error;
for (int i = 0; i < sizeof(es9p_errors) / sizeof(es9p_errors[0]); i++)
{
error = es9p_errors[i];
if (strcmp(error.subject_code, subject_code) == 0 && strcmp(error.reason_code, reason_code) == 0)
{
return error.description;
}
}
return NULL;
}

3
euicc/es9p_errors.h Normal file
View file

@ -0,0 +1,3 @@
#pragma once
const char* es9p_error_message(const char *subject_code, const char *reason_code);

View file

@ -99,9 +99,9 @@ int es10x_command_iter(struct euicc_ctx *ctx, const uint8_t *der_req, unsigned r
while (req_len) while (req_len)
{ {
uint8_t rlen; uint8_t rlen;
if (req_len > 120) if (req_len > ctx->es10x_mss)
{ {
rlen = 120; rlen = ctx->es10x_mss;
ret = es10x_command_buildrequest_continue(ctx, reqseq, &req, req_ptr, rlen); ret = es10x_command_buildrequest_continue(ctx, reqseq, &req, req_ptr, rlen);
} }
else else
@ -172,15 +172,27 @@ int euicc_init(struct euicc_ctx *ctx)
{ {
int ret; int ret;
if (ctx->aid == NULL)
{
ctx->aid = (const uint8_t *)ISD_R_AID;
ctx->aid_len = sizeof(ISD_R_AID) - 1;
}
if (ctx->es10x_mss == 0)
{
ctx->es10x_mss = 120;
}
ret = ctx->apdu.interface->connect(ctx); ret = ctx->apdu.interface->connect(ctx);
if (ret < 0) if (ret < 0)
{ {
return -1; return -1;
} }
ret = ctx->apdu.interface->logic_channel_open(ctx, (const uint8_t *)ISD_R_AID, sizeof(ISD_R_AID) - 1); ret = ctx->apdu.interface->logic_channel_open(ctx, ctx->aid, ctx->aid_len);
if (ret < 0) if (ret < 0)
{ {
ctx->apdu.interface->disconnect(ctx);
return -1; return -1;
} }
@ -198,22 +210,17 @@ void euicc_fini(struct euicc_ctx *ctx)
void euicc_http_cleanup(struct euicc_ctx *ctx) void euicc_http_cleanup(struct euicc_ctx *ctx)
{ {
free(ctx->http._internal.transaction_id); free(ctx->http._internal.transaction_id_http);
ctx->http._internal.transaction_id = NULL; free(ctx->http._internal.transaction_id_bin);
free(ctx->http._internal.b64_euicc_challenge); free(ctx->http._internal.b64_euicc_challenge);
ctx->http._internal.b64_euicc_challenge = NULL;
free(ctx->http._internal.b64_euicc_info_1); free(ctx->http._internal.b64_euicc_info_1);
ctx->http._internal.b64_euicc_info_1 = NULL;
es10b_authenticate_server_param_free(ctx->http._internal.authenticate_server_param); es10b_authenticate_server_param_free(ctx->http._internal.authenticate_server_param);
free(ctx->http._internal.authenticate_server_param); free(ctx->http._internal.authenticate_server_param);
ctx->http._internal.authenticate_server_param = NULL;
free(ctx->http._internal.b64_authenticate_server_response); free(ctx->http._internal.b64_authenticate_server_response);
ctx->http._internal.b64_authenticate_server_response = NULL;
es10b_prepare_download_param_free(ctx->http._internal.prepare_download_param); es10b_prepare_download_param_free(ctx->http._internal.prepare_download_param);
free(ctx->http._internal.prepare_download_param); free(ctx->http._internal.prepare_download_param);
ctx->http._internal.prepare_download_param = NULL;
free(ctx->http._internal.b64_prepare_download_response); free(ctx->http._internal.b64_prepare_download_response);
ctx->http._internal.b64_prepare_download_response = NULL;
free(ctx->http._internal.b64_bound_profile_package); free(ctx->http._internal.b64_bound_profile_package);
ctx->http._internal.b64_bound_profile_package = NULL; free(ctx->http._internal.b64_cancel_session_response);
memset(&ctx->http._internal, 0, sizeof(ctx->http._internal));
} }

View file

@ -6,6 +6,9 @@
struct euicc_ctx struct euicc_ctx
{ {
const uint8_t *aid;
uint8_t aid_len;
uint8_t es10x_mss;
struct struct
{ {
const struct euicc_apdu_interface *interface; const struct euicc_apdu_interface *interface;
@ -32,7 +35,9 @@ struct euicc_ctx
} status; } status;
struct struct
{ {
char *transaction_id; char *transaction_id_http;
uint8_t *transaction_id_bin;
uint32_t transaction_id_bin_len;
char *b64_euicc_challenge; char *b64_euicc_challenge;
char *b64_euicc_info_1; char *b64_euicc_info_1;
struct es10b_authenticate_server_param *authenticate_server_param; struct es10b_authenticate_server_param *authenticate_server_param;
@ -40,6 +45,7 @@ struct euicc_ctx
struct es10b_prepare_download_param *prepare_download_param; struct es10b_prepare_download_param *prepare_download_param;
char *b64_prepare_download_response; char *b64_prepare_download_response;
char *b64_bound_profile_package; char *b64_bound_profile_package;
char *b64_cancel_session_response;
} _internal; } _internal;
} http; } http;
void *userdata; void *userdata;

View file

@ -94,7 +94,7 @@ int euicc_hexutil_hex2bin_r(uint8_t *output, uint32_t output_len, const char *st
return length; return length;
} }
int euicc_hexutil_gsmbcd2bin(uint8_t *output, uint32_t output_len, const char *str) int euicc_hexutil_gsmbcd2bin(uint8_t *output, uint32_t output_len, const char *str, uint32_t padding_to)
{ {
uint32_t str_length; uint32_t str_length;
uint32_t idx = 0; uint32_t idx = 0;
@ -106,6 +106,11 @@ int euicc_hexutil_gsmbcd2bin(uint8_t *output, uint32_t output_len, const char *s
return -1; return -1;
} }
if (output_len < padding_to)
{
return -1;
}
for (uint32_t i = 0; i < str_length; i += 2) for (uint32_t i = 0; i < str_length; i += 2)
{ {
char high_nibble = (i + 1 < str_length) ? str[i + 1] : 'F'; char high_nibble = (i + 1 < str_length) ? str[i + 1] : 'F';
@ -132,31 +137,37 @@ int euicc_hexutil_gsmbcd2bin(uint8_t *output, uint32_t output_len, const char *s
idx++; idx++;
} }
for (; idx < padding_to; idx++)
{
output[idx] = 0xFF;
}
return idx; return idx;
} }
int euicc_hexutil_bin2gsmbcd(char *output, uint32_t output_len, const uint8_t *binData, uint32_t length) int euicc_hexutil_bin2gsmbcd(char *output, uint32_t output_len, const uint8_t *binData, uint32_t length)
{ {
int j = 0;
if (euicc_hexutil_bin2hex(output, output_len, binData, length)) if (euicc_hexutil_bin2hex(output, output_len, binData, length))
{ {
return -1; return -1;
} }
length = strlen(output); length = strlen(output);
for (uint32_t i = 0; i < length - 1; i += 2) for (int i = 0; i < length - 1; i += 2)
{ {
char temp = output[i]; char temp = output[i];
output[j++] = output[i + 1]; output[i] = output[i + 1];
output[j++] = temp; output[i + 1] = temp;
} }
if (j > 0 && output[j - 1] == 'f') for (int i = length - 1; i >= 0; i--)
{ {
j--; if (output[i] != 'f')
{
break;
}
output[i] = '\0';
} }
output[j] = '\0';
return 0; return 0;
} }

View file

@ -4,5 +4,5 @@
int euicc_hexutil_hex2bin_r(uint8_t *output, uint32_t output_len, const char *str, uint32_t str_len); int euicc_hexutil_hex2bin_r(uint8_t *output, uint32_t output_len, const char *str, uint32_t str_len);
int euicc_hexutil_hex2bin(uint8_t *output, uint32_t output_len, const char *str); int euicc_hexutil_hex2bin(uint8_t *output, uint32_t output_len, const char *str);
int euicc_hexutil_bin2hex(char *output, uint32_t output_len, const uint8_t *bin, uint32_t bin_len); int euicc_hexutil_bin2hex(char *output, uint32_t output_len, const uint8_t *bin, uint32_t bin_len);
int euicc_hexutil_gsmbcd2bin(uint8_t *output, uint32_t output_len, const char *str); int euicc_hexutil_gsmbcd2bin(uint8_t *output, uint32_t output_len, const char *str, uint32_t padding_to);
int euicc_hexutil_bin2gsmbcd(char *output, uint32_t output_len, const uint8_t *binData, uint32_t length); int euicc_hexutil_bin2gsmbcd(char *output, uint32_t output_len, const uint8_t *binData, uint32_t length);

68
scripts/build-ci.sh Executable file
View file

@ -0,0 +1,68 @@
#!/bin/bash
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
source "$SCRIPT_DIR/functions.sh"
set -euo pipefail
BUILD="$(mktemp -d)"
ARTIFACT="$WORKSPACE/build"
cd "$BUILD" || exit 1
mkdir -p "$BUILD/output"
mkdir -p "$ARTIFACT"
case "${1:-}" in
make)
cmake "$WORKSPACE"
make -j
copy-license "$BUILD/output"
copy-usage "$BUILD/output"
create-bundle "$ARTIFACT/lpac-$KERNEL-$MATCHINE.zip" "$BUILD/output"
;;
make-without-lto)
cmake -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=OFF "$WORKSPACE"
make -j
copy-license "$BUILD/output"
copy-usage "$BUILD/output"
create-bundle "$ARTIFACT/lpac-$KERNEL-$MATCHINE-without-lto.zip" "$BUILD/output"
;;
debian)
cmake "$WORKSPACE" -DCPACK_GENERATOR=DEB
make -j package
cp lpac_*.deb "$ARTIFACT"
;;
mingw)
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/linux-mingw64.cmake
make -j
copy-license "$BUILD/output"
copy-curl-win "$BUILD/output"
copy-usage "$BUILD/output"
create-bundle "$ARTIFACT/lpac-windows-x86_64-mingw.zip" "$BUILD/output"
;;
woa-mingw)
TOOLCHAIN="$(download "$MINGW32_TOOLCHAIN_BLOB")"
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/linux-mingw64-woa.cmake "-DTOOLCHAIN_BIN_PATH=$TOOLCHAIN/bin"
make -j
rm -rf "$TOOLCHAIN"
copy-license "$BUILD/output"
copy-curl-woa "$BUILD/output"
copy-usage "$BUILD/output"
create-bundle "$ARTIFACT/lpac-windows-arm64-mingw.zip" "$BUILD/output"
;;
woa-zig)
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/aarch64-windows-zig.cmake
make -j
copy-license "$BUILD/output"
copy-curl-woa "$BUILD/output"
copy-usage "$BUILD/output"
create-bundle "$ARTIFACT/lpac-windows-arm64-zig.zip" "$BUILD/output"
;;
*)
echo "Usage: $0 {make,debian,mingw,woa-mingw,woa-zig}"
exit 1
;;
esac
rm -rf "$BUILD"

33
scripts/build-woa.sh Executable file
View file

@ -0,0 +1,33 @@
#!/bin/bash
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
source "$SCRIPT_DIR/functions.sh"
set -euo pipefail
BUILD="$(mktemp -d)"
cd "$BUILD" || exit 1
case "${1:-}" in
mingw)
TOOLCHAIN="$(download "$MINGW32_TOOLCHAIN_BLOB")"
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/linux-mingw64-woa.cmake "-DTOOLCHAIN_BIN_PATH=$TOOLCHAIN/bin"
make -j
copy-license "$BUILD/output"
copy-curl-woa "$BUILD/output"
copy-usage "$BUILD/output"
;;
zig)
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/aarch64-windows-zig.cmake
make -j
copy-license "$BUILD/output"
copy-curl-woa "$BUILD/output"
copy-usage "$BUILD/output"
;;
*)
echo "Usage: $0 {mingw,zig}"
exit 1
;;
esac
rm -rf "$BUILD"

View file

@ -1,88 +0,0 @@
#!/bin/bash
set -euo pipefail
WORKSPACE="$(pwd)"
KERNEL="$(uname -s)"
MATCHINE="$(uname -m)"
CURL_VERSION="8.6.0_1"
WOA_TOOLCHAIN_VERSION="2024-02-08"
MINGW_CURL_WIN64_BLOB="https://curl.se/windows/dl-$CURL_VERSION/curl-$CURL_VERSION-win64-mingw.zip"
MINGW_CURL_WIN64A_BLOB="https://curl.se/windows/dl-$CURL_VERSION/curl-$CURL_VERSION-win64a-mingw.zip"
MINGW32_TOOLCHAIN_BLOB="https://github.com/Windows-on-ARM-Experiments/mingw-woarm64-build/releases/download/$WOA_TOOLCHAIN_VERSION/aarch64-w64-mingw32-msvcrt-toolchain.tar.gz"
case "$KERNEL" in
Linux)
KERNEL="linux"
;;
Darwin)
KERNEL="darwin"
MATCHINE="universal"
;;
esac
function download {
URL="$1"
SAVED_PATH="$(mktemp)"
SAVED_DIR="$(mktemp -d)"
wget --no-verbose "$URL" -O "$SAVED_PATH"
case "$URL" in
*.zip)
unzip -q -d "$SAVED_DIR" "$SAVED_PATH"
rm "$SAVED_PATH"
echo "$SAVED_DIR"
;;
*.tar.gz)
tar -C "$SAVED_DIR" --gzip --extract --file="$SAVED_PATH"
rm "$SAVED_PATH"
echo "$SAVED_DIR"
;;
*)
echo "$SAVED_PATH"
;;
esac
}
set -x
BUILD="$(mktemp -d)"
cd "$BUILD" || exit 1
case "${1:-}" in
make)
cmake "$WORKSPACE"
make -j
zip -r -j "$WORKSPACE/lpac-$KERNEL-$MATCHINE.zip" output/*
;;
debian)
cmake "$WORKSPACE" -DCPACK_GENERATOR=DEB
make -j package
cp lpac-*.deb "$WORKSPACE"
;;
mingw)
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/linux-mingw64.cmake
make -j
CURL="$(download "$MINGW_CURL_WIN64_BLOB")"
cp "$CURL"/curl-*-mingw/bin/libcurl-x64.dll output/libcurl.dll
zip -r -j "$WORKSPACE/lpac-windows-x86_64-mingw.zip" output/*
;;
woa-mingw)
TOOLCHAIN="$(download "$MINGW32_TOOLCHAIN_BLOB")"
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/linux-mingw64-woa.cmake "-DTOOLCHAIN_BIN_PATH=$TOOLCHAIN/bin"
make -j
CURL="$(download "$MINGW_CURL_WIN64A_BLOB")"
cp "$CURL"/curl-*-mingw/bin/libcurl-arm64.dll output/libcurl.dll
zip -r -j "$WORKSPACE/lpac-windows-arm64-mingw.zip" output/*
;;
woa-zig)
cmake "$WORKSPACE" -DCMAKE_TOOLCHAIN_FILE=./cmake/aarch64-windows-zig.cmake
make -j
CURL="$(download "$MINGW_CURL_WIN64A_BLOB")"
cp "$CURL"/curl-*-mingw/bin/libcurl-arm64.dll output/libcurl.dll
zip -r -j "$WORKSPACE/lpac-windows-arm64-zig.zip" output/*
;;
*)
echo "Usage: $0 {make,debian,mingw,woa-mingw,woa-zig}"
exit 1
;;
esac
rm -rf "$BUILD"

84
scripts/functions.sh Normal file
View file

@ -0,0 +1,84 @@
#!/bin/bash
export KERNEL="$(uname -s)"
export MATCHINE="$(uname -m)"
export WORKSPACE="${GITHUB_WORKSPACE:-$(pwd)}"
export CURL_VERSION="8.6.0_1"
export WOA_TOOLCHAIN_VERSION="2024-02-08"
export MINGW_CURL_WIN64_BLOB="https://curl.se/windows/dl-$CURL_VERSION/curl-$CURL_VERSION-win64-mingw.zip"
export MINGW_CURL_WIN64A_BLOB="https://curl.se/windows/dl-$CURL_VERSION/curl-$CURL_VERSION-win64a-mingw.zip"
export MINGW32_TOOLCHAIN_BLOB="https://github.com/Windows-on-ARM-Experiments/mingw-woarm64-build/releases/download/$WOA_TOOLCHAIN_VERSION/aarch64-w64-mingw32-msvcrt-toolchain.tar.gz"
case "$KERNEL" in
Linux)
KERNEL="linux"
;;
Darwin)
KERNEL="darwin"
MATCHINE="universal"
;;
esac
function download {
local URL="$1"
local SAVED_PATH="$(mktemp)"
local SAVED_DIR="$(mktemp -d)"
wget --no-verbose "$URL" -O "$SAVED_PATH"
case "$URL" in
*.zip)
unzip -q -d "$SAVED_DIR" "$SAVED_PATH"
rm "$SAVED_PATH"
echo "$SAVED_DIR"
;;
*.tar.gz)
tar -C "$SAVED_DIR" --gzip --extract --file="$SAVED_PATH"
rm "$SAVED_PATH"
echo "$SAVED_DIR"
;;
*)
echo "$SAVED_PATH"
;;
esac
}
function copy-license {
local OUTPUT="$1"
cp "$WORKSPACE/src/LICENSE" "$OUTPUT/LICENSE-lpac"
cp "$WORKSPACE/euicc/LICENSE" "$OUTPUT/LICENSE-libeuicc"
cp "$WORKSPACE/cjson/LICENSE" "$OUTPUT/LICENSE-cjson"
cp "$WORKSPACE/dlfcn-win32/LICENSE" "$OUTPUT/LICENSE-dlfcn-win32"
}
function copy-curl-woa {
local OUTPUT="$1"
CURL="$(download "$MINGW_CURL_WIN64A_BLOB")"
cp "$CURL"/curl-*-mingw/bin/libcurl-arm64.dll "$OUTPUT/libcurl.dll"
cp "$CURL"/curl-*-mingw/COPYING.txt "$OUTPUT/LICENSE-libcurl"
rm -rf "$CURL"
}
function copy-curl-win {
local OUTPUT="$1"
CURL="$(download "$MINGW_CURL_WIN64_BLOB")"
cp "$CURL"/curl-*-mingw/bin/libcurl-x64.dll "$OUTPUT/libcurl.dll"
cp "$CURL"/curl-*-mingw/COPYING.txt "$OUTPUT/LICENSE-libcurl"
rm -rf "$CURL"
}
function copy-usage {
local OUTPUT="$1"
cp "$WORKSPACE/docs/USAGE.md" "$OUTPUT/README.md"
}
function create-bundle {
local BUNDLE_FILE="$1"
local INPUT_DIR="$2"
pushd "$INPUT_DIR"
zip -r "$BUNDLE_FILE" *
popd
}

View file

@ -1,4 +1,13 @@
#!/bin/bash #!/bin/bash
set -xeuo pipefail set -euo pipefail
sudo apt-get update export DEBIAN_FRONTEND=noninteractive
sudo apt-get install -y build-essential libpcsclite-dev libcurl4-openssl-dev gcc-mingw-w64 g++-mingw-w64 export DEBIAN_PRIORITY=critical
apt-get -qq -o=Dpkg::Use-Pty=0 update
apt-get -qq -o=Dpkg::Use-Pty=0 install -y build-essential libpcsclite-dev libcurl4-openssl-dev zip
case "${1:-}" in
mingw)
apt-get -qq -o=Dpkg::Use-Pty=0 install gcc-mingw-w64 g++-mingw-w64
;;
esac

View file

@ -21,7 +21,7 @@ add_custom_target(version
-D SRC=${CMAKE_CURRENT_SOURCE_DIR}/version.h.in -D SRC=${CMAKE_CURRENT_SOURCE_DIR}/version.h.in
-D DST=${CMAKE_CURRENT_SOURCE_DIR}/version.h -D DST=${CMAKE_CURRENT_SOURCE_DIR}/version.h
-D GIT_EXECUTABLE=${GIT_EXECUTABLE} -D GIT_EXECUTABLE=${GIT_EXECUTABLE}
-P ${CMAKE_MODULE_PATH}/git-version.cmake -P ${LPAC_CMAKE_MODULE_PATH}/git-version.cmake
) )
add_dependencies(lpac version) add_dependencies(lpac version)
set_target_properties(lpac PROPERTIES set_target_properties(lpac PROPERTIES

View file

@ -17,9 +17,10 @@ static const struct applet_entry *applets[] = {
NULL, NULL,
}; };
static int applet_main(int argc, char **argv) static int applet_main(const int argc, char **argv)
{ {
main_init_euicc(); const int ret = main_init_euicc();
if (ret != 0) return ret;
return applet_entry(argc, argv, applets); return applet_entry(argc, argv, applets);
} }

View file

@ -14,10 +14,9 @@ static int applet_main(int argc, char **argv)
{ {
char *eid = NULL; char *eid = NULL;
struct es10a_euicc_configured_addresses addresses; struct es10a_euicc_configured_addresses addresses;
struct es10b_rat *ratList;
struct es10c_ex_euiccinfo2 euiccinfo2; struct es10c_ex_euiccinfo2 euiccinfo2;
cJSON *jaddresses = NULL; cJSON *jaddresses = NULL, *jratList = NULL, *jeuiccinfo2 = NULL, *jdata = NULL;
cJSON *jeuiccinfo2 = NULL;
cJSON *jdata = NULL;
if (es10c_get_eid(&euicc_ctx, &eid)) if (es10c_get_eid(&euicc_ctx, &eid))
{ {
@ -30,6 +29,11 @@ static int applet_main(int argc, char **argv)
jaddresses = cJSON_CreateObject(); jaddresses = cJSON_CreateObject();
} }
if (es10b_get_rat(&euicc_ctx, &ratList) == 0)
{
jratList = cJSON_CreateArray();
}
if (es10c_ex_get_euiccinfo2(&euicc_ctx, &euiccinfo2) == 0) if (es10c_ex_get_euiccinfo2(&euicc_ctx, &euiccinfo2) == 0)
{ {
jeuiccinfo2 = cJSON_CreateObject(); jeuiccinfo2 = cJSON_CreateObject();
@ -123,6 +127,50 @@ static int applet_main(int argc, char **argv)
} }
cJSON_AddItemToObject(jdata, "EUICCInfo2", jeuiccinfo2); cJSON_AddItemToObject(jdata, "EUICCInfo2", jeuiccinfo2);
if (jratList)
{
while (ratList) {
struct cJSON *jrat = cJSON_CreateObject();
if (ratList->pprIds)
{
cJSON *jPPR = cJSON_CreateArray();
for (int i = 0; ratList->pprIds[i] != NULL; i++)
{
cJSON_AddItemToArray(jPPR, cJSON_CreateString(ratList->pprIds[i]));
}
cJSON_AddItemToObject(jrat, "pprIds", jPPR);
}
if (ratList->allowedOperators)
{
cJSON *jAllowedOperators = cJSON_CreateArray();
const struct es10b_operation_id *rptr = ratList->allowedOperators;
while (rptr)
{
cJSON *joperator = cJSON_CreateObject();
cJSON_AddStringOrNullToObject(joperator, "plmn", rptr->plmn);
cJSON_AddStringOrNullToObject(joperator, "gid1", rptr->gid1);
cJSON_AddStringOrNullToObject(joperator, "gid2", rptr->gid2);
cJSON_AddItemToArray(jAllowedOperators, joperator);
rptr = rptr->next;
}
cJSON_AddItemToObject(jrat, "allowedOperators", jAllowedOperators);
}
if (ratList->pprFlags)
{
cJSON *jFlags = cJSON_CreateArray();
for (int i = 0; ratList->pprFlags[i] != NULL; i++)
{
cJSON_AddItemToArray(jFlags, cJSON_CreateString(ratList->pprFlags[i]));
}
cJSON_AddItemToObject(jrat, "pprFlags", jFlags);
}
cJSON_AddItemToArray(jratList, jrat);
ratList = ratList->next;
}
cJSON_AddItemToObject(jdata, "rulesAuthorisationTable", jratList);
es10b_rat_list_free_all(ratList);
}
jprint_success(jdata); jprint_success(jdata);
return 0; return 0;

View file

@ -17,9 +17,10 @@ static const struct applet_entry *applets[] = {
NULL, NULL,
}; };
static int applet_main(int argc, char **argv) static int applet_main(const int argc, char **argv)
{ {
main_init_euicc(); const int ret = main_init_euicc();
if (ret != 0) return ret;
return applet_entry(argc, argv, applets); return applet_entry(argc, argv, applets);
} }

View file

@ -3,53 +3,21 @@
#include <stdlib.h> #include <stdlib.h>
#include <unistd.h> #include <unistd.h>
#include <string.h> #include <string.h>
#include <errno.h>
#include <main.h> #include <main.h>
#include <euicc/es10b.h> #include <euicc/es10b.h>
#include <euicc/es9p.h> #include <euicc/es9p.h>
static void _help(const char *applet_name) static int _process_single(uint32_t seqNumber, uint8_t autoremove)
{ {
printf("Usage: %s [seqNumber] [-r]\r\n", applet_name); int ret;
printf("\t -r\tAutomatically remove processed notifications\r\n"); char str_seqNumber[11];
}
static int applet_main(int argc, char **argv)
{
unsigned long seqNumber;
char *str_seqNumber = NULL;
int autoremove = 0;
struct es10b_pending_notification notification; struct es10b_pending_notification notification;
for (int i = 0; i < argc; i++) snprintf(str_seqNumber, sizeof(str_seqNumber), "%u", seqNumber);
{
if (strcmp(argv[i], "-h") == 0)
{
_help(argv[0]);
return -1;
}
else if (strcmp(argv[i], "-r") == 0)
{
autoremove = 1;
}
else
{
if (i && !str_seqNumber)
{
str_seqNumber = argv[i];
}
}
}
if (str_seqNumber == NULL) jprint_progress("es10b_retrieve_notifications_list", str_seqNumber);
{
_help(argv[0]);
return -1;
}
seqNumber = atol(str_seqNumber);
jprint_progress("es10b_retrieve_notifications_list");
if (es10b_retrieve_notifications_list(&euicc_ctx, &notification, seqNumber)) if (es10b_retrieve_notifications_list(&euicc_ctx, &notification, seqNumber))
{ {
jprint_error("es10b_retrieve_notifications_list", NULL); jprint_error("es10b_retrieve_notifications_list", NULL);
@ -58,7 +26,7 @@ static int applet_main(int argc, char **argv)
euicc_ctx.http.server_address = notification.notificationAddress; euicc_ctx.http.server_address = notification.notificationAddress;
jprint_progress("es9p_handle_notification"); jprint_progress("es9p_handle_notification", str_seqNumber);
if (es9p_handle_notification(&euicc_ctx, notification.b64_PendingNotification)) if (es9p_handle_notification(&euicc_ctx, notification.b64_PendingNotification))
{ {
jprint_error("es9p_handle_notification", NULL); jprint_error("es9p_handle_notification", NULL);
@ -67,19 +35,115 @@ static int applet_main(int argc, char **argv)
es10b_pending_notification_free(&notification); es10b_pending_notification_free(&notification);
if (autoremove) if (!autoremove)
{ {
jprint_progress("es10b_remove_notification_from_list"); return 0;
if (es10b_remove_notification_from_list(&euicc_ctx, seqNumber)) }
jprint_progress("es10b_remove_notification_from_list", str_seqNumber);
if ((ret = es10b_remove_notification_from_list(&euicc_ctx, seqNumber)))
{
const char *reason;
switch (ret)
{ {
jprint_error("es10b_remove_notification_from_list", NULL); case 1:
reason = "seqNumber not found";
break;
default:
reason = "unknown";
break;
}
jprint_error("es10b_remove_notification_from_list", reason);
return -1;
}
return 0;
}
static int applet_main(int argc, char **argv)
{
static const char *opt_string = "arh?";
int fret = 0;
int all = 0;
int autoremove = 0;
int opt = 0;
while ((opt = getopt(argc, argv, opt_string)) != -1)
{
switch (opt)
{
case 'a':
all = 1;
break;
case 'r':
autoremove = 1;
break;
case 'h':
case '?':
printf("Usage: %s [OPTIONS] [seqNumber_0] [seqNumber_1]...\n", argv[0]);
printf("\t -a All notifications\n");
printf("\t -r Automatically remove processed notifications\n");
return -1; return -1;
default:
break;
} }
} }
jprint_success(NULL); if (all)
{
struct es10b_notification_metadata_list *notifications, *rptr;
return 0; jprint_progress("es10b_list_notification", NULL);
if (es10b_list_notification(&euicc_ctx, &notifications))
{
jprint_error("es10b_list_notification", NULL);
return -1;
}
rptr = notifications;
while (rptr)
{
if (_process_single(rptr->seqNumber, autoremove))
{
fret = -1;
break;
}
rptr = rptr->next;
}
es10b_notification_metadata_list_free_all(notifications);
}
else
{
for (int i = optind; i < argc; i++)
{
unsigned long seqNumber;
errno = 0;
char *str_end;
seqNumber = strtoul(argv[i], &str_end, 10);
// Although POSIX said user should check errno instead of return value,
// but errno may not be set when no conversion is performed according to C99.
// Check nptr is same as str_end to ensure there is no conversion.
if ((seqNumber == 0 && strcmp(argv[i], str_end)) || errno != 0)
{
continue;
}
if (_process_single(seqNumber, autoremove))
{
fret = -1;
break;
}
}
}
if (fret == 0)
{
jprint_success(NULL);
}
return fret;
} }
struct applet_entry applet_notification_process = { struct applet_entry applet_notification_process = {

View file

@ -2,24 +2,20 @@
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <unistd.h> #include <unistd.h>
#include <errno.h>
#include <string.h> #include <string.h>
#include <main.h> #include <main.h>
#include <euicc/es10b.h> #include <euicc/es10b.h>
static int applet_main(int argc, char **argv) static int _delete_single(uint32_t seqNumber)
{ {
char str_seqNumber[11];
int ret; int ret;
unsigned long seqNumber;
if (argc < 2) snprintf(str_seqNumber, sizeof(str_seqNumber), "%u", seqNumber);
{
printf("Usage: %s <seqNumber>\n", argv[0]);
return -1;
}
seqNumber = atol(argv[1]);
jprint_progress("es10b_remove_notification_from_list", str_seqNumber);
if ((ret = es10b_remove_notification_from_list(&euicc_ctx, seqNumber))) if ((ret = es10b_remove_notification_from_list(&euicc_ctx, seqNumber)))
{ {
const char *reason; const char *reason;
@ -36,11 +32,91 @@ static int applet_main(int argc, char **argv)
return -1; return -1;
} }
jprint_success(NULL);
return 0; return 0;
} }
static int applet_main(int argc, char **argv)
{
static const char *opt_string = "ah?";
int fret = 0;
int all = 0;
int opt = 0;
while ((opt = getopt(argc, argv, opt_string)) != -1)
{
switch (opt)
{
case 'a':
all = 1;
break;
case 'h':
case '?':
printf("Usage: %s [OPTIONS] [seqNumber_0] [seqNumber_1]...\n", argv[0]);
printf("\t -a All notifications\n");
return -1;
default:
break;
}
}
if (all)
{
struct es10b_notification_metadata_list *notifications, *rptr;
jprint_progress("es10b_list_notification", NULL);
if (es10b_list_notification(&euicc_ctx, &notifications))
{
jprint_error("es10b_list_notification", NULL);
return -1;
}
rptr = notifications;
while (rptr)
{
if (_delete_single(rptr->seqNumber))
{
fret = -1;
break;
}
rptr = rptr->next;
}
es10b_notification_metadata_list_free_all(notifications);
}
else
{
for (int i = optind; i < argc; i++)
{
unsigned long seqNumber;
errno = 0;
char *str_end;
seqNumber = strtoul(argv[i], &str_end, 10);
// Although POSIX said user should check errno instead of return value,
// but errno may not be set when no conversion is performed according to C99.
// Check nptr is same as str_end to ensure there is no conversion.
if ((seqNumber == 0 && strcmp(argv[i], str_end)) || errno != 0)
{
continue;
}
if (_delete_single(seqNumber))
{
fret = -1;
break;
}
}
}
if (fret == 0)
{
jprint_success(NULL);
}
return fret;
}
struct applet_entry applet_notification_remove = { struct applet_entry applet_notification_remove = {
.name = "remove", .name = "remove",
.main = applet_main, .main = applet_main,

View file

@ -25,9 +25,10 @@ static const struct applet_entry *applets[] = {
NULL, NULL,
}; };
static int applet_main(int argc, char **argv) static int applet_main(const int argc, char **argv)
{ {
main_init_euicc(); const int ret = main_init_euicc();
if (ret != 0) return ret;
return applet_entry(argc, argv, applets); return applet_entry(argc, argv, applets);
} }

View file

@ -43,7 +43,7 @@ static int applet_main(int argc, char **argv)
reason = "unknown"; reason = "unknown";
break; break;
} }
jprint_error("es10c_disable_profile", reason); jprint_error("es10c_delete_profile", reason);
return -1; return -1;
} }

View file

@ -24,8 +24,7 @@ static int applet_main(int argc, char **argv)
cJSON *jdata = NULL; cJSON *jdata = NULL;
opt = getopt(argc, argv, opt_string); while ((opt = getopt(argc, argv, opt_string)) != -1)
while (opt != -1)
{ {
switch (opt) switch (opt)
{ {
@ -37,10 +36,10 @@ static int applet_main(int argc, char **argv)
break; break;
case 'h': case 'h':
case '?': case '?':
printf("Usage: %s [OPTIONS]\r\n", argv[0]); printf("Usage: %s [OPTIONS]\n", argv[0]);
printf("\t -s SM-DS Domain\r\n"); printf("\t -s SM-DS Domain\n");
printf("\t -i IMEI\r\n"); printf("\t -i IMEI\n");
printf("\t -h This help info\r\n"); printf("\t -h This help info\n");
return -1; return -1;
break; break;
} }
@ -56,28 +55,28 @@ static int applet_main(int argc, char **argv)
euicc_ctx.http.server_address = smds; euicc_ctx.http.server_address = smds;
jprint_progress("es10b_get_euicc_challenge_and_info"); jprint_progress("es10b_get_euicc_challenge_and_info", smds);
if (es10b_get_euicc_challenge_and_info(&euicc_ctx)) if (es10b_get_euicc_challenge_and_info(&euicc_ctx))
{ {
jprint_error("es10b_get_euicc_challenge_and_info", NULL); jprint_error("es10b_get_euicc_challenge_and_info", NULL);
goto err; goto err;
} }
jprint_progress("es9p_initiate_authentication"); jprint_progress("es9p_initiate_authentication", smds);
if (es9p_initiate_authentication(&euicc_ctx)) if (es9p_initiate_authentication(&euicc_ctx))
{ {
jprint_error("es9p_initiate_authentication", euicc_ctx.http.status.message); jprint_error("es9p_initiate_authentication", euicc_ctx.http.status.message);
goto err; goto err;
} }
jprint_progress("es10b_authenticate_server"); jprint_progress("es10b_authenticate_server", smds);
if (es10b_authenticate_server(&euicc_ctx, NULL, imei)) if (es10b_authenticate_server(&euicc_ctx, NULL, imei))
{ {
jprint_error("es10b_authenticate_server", NULL); jprint_error("es10b_authenticate_server", NULL);
goto err; goto err;
} }
jprint_progress("es11_authenticate_client"); jprint_progress("es11_authenticate_client", smds);
if (es11_authenticate_client(&euicc_ctx, &smdp_list)) if (es11_authenticate_client(&euicc_ctx, &smdp_list))
{ {
jprint_error("es11_authenticate_client", NULL); jprint_error("es11_authenticate_client", NULL);

View file

@ -5,17 +5,48 @@
#include <string.h> #include <string.h>
#include <getopt.h> #include <getopt.h>
#include <main.h> #include <main.h>
#include <signal.h>
#include <euicc/es10a.h> #include <euicc/es10a.h>
#include <euicc/es10b.h> #include <euicc/es10b.h>
#include <euicc/es9p.h> #include <euicc/es9p.h>
#include <euicc/es8p.h>
#include <euicc/tostr.h> #include <euicc/tostr.h>
static const char *opt_string = "s:m:i:c:h?"; static const char *opt_string = "s:m:i:c:a:ph?";
static volatile int cancelled = 0;
#define CANCELPOINT() \
if (cancelled) \
{ \
goto err; \
}
#ifdef _WIN32
// https://stackoverflow.com/a/58244503
char *strsep(char **stringp, const char *__delim) {
char *rv = *stringp;
if (!rv) return rv;
*stringp += strcspn(*stringp, __delim);
if (**stringp)
*(*stringp)++ = '\0';
else
*stringp = 0;
return rv;
}
#endif
static void sigint_handler(int x)
{
cancelled = 1;
}
static int applet_main(int argc, char **argv) static int applet_main(int argc, char **argv)
{ {
int fret; int fret;
const char *error_function_name = NULL;
const char *error_detail = NULL;
int opt; int opt;
@ -23,12 +54,16 @@ static int applet_main(int argc, char **argv)
char *matchingId = NULL; char *matchingId = NULL;
char *imei = NULL; char *imei = NULL;
char *confirmation_code = NULL; char *confirmation_code = NULL;
char *activation_code = NULL;
int interactive_preview = 0;
struct es10a_euicc_configured_addresses configured_addresses = {0}; struct es10a_euicc_configured_addresses configured_addresses = {0};
struct es10b_load_bound_profile_package_result download_result = {0}; struct es10b_load_bound_profile_package_result download_result = {0};
opt = getopt(argc, argv, opt_string); cJSON *jmetadata = NULL;
while (opt != -1) struct es8p_metadata *profile_metadata = NULL;
while ((opt = getopt(argc, argv, opt_string)) != -1)
{ {
switch (opt) switch (opt)
{ {
@ -44,26 +79,83 @@ static int applet_main(int argc, char **argv)
case 'c': case 'c':
confirmation_code = strdup(optarg); confirmation_code = strdup(optarg);
break; break;
case 'a':
activation_code = strdup(optarg);
if (strncmp(activation_code, "LPA:", 4) == 0)
{
activation_code += 4; // ignore uri scheme
}
break;
case 'p':
interactive_preview = 1;
break;
case 'h': case 'h':
case '?': case '?':
printf("Usage: %s [OPTIONS]\r\n", argv[0]); printf("Usage: %s [OPTIONS]\n", argv[0]);
printf("\t -s SM-DP+ Domain\r\n"); printf("\t -s SM-DP+ Domain\n");
printf("\t -m Matching ID\r\n"); printf("\t -m Matching ID\n");
printf("\t -i IMEI\r\n"); printf("\t -i IMEI\n");
printf("\t -c Confirmation Code (Password)\r\n"); printf("\t -c Confirmation Code (Password)\n");
printf("\t -h This help info\r\n"); printf("\t -a Activation Code (e.g: 'LPA:***')\n");
printf("\t -p Interactive preview profile\n");
printf("\t -h This help info\n");
return -1; return -1;
default:
break; break;
} }
opt = getopt(argc, argv, opt_string); }
if (activation_code != NULL)
{
// SGP.22 v2.2.2; Page 111
// Section: 4.1 (Activation Code)
const char *token = NULL;
int index = 0;
while ((token = strsep(&activation_code, "$")) != NULL)
{
switch (index)
{
case 0: // Activation Code Format
if (strncmp(token, "1", strlen(token)) != 0)
{
error_function_name = "activation_code";
error_detail = "invalid";
goto err;
}
break;
case 1: // SM-DP+ Address
smdp = strdup(token);
break;
case 2: // AC_Token or Matching ID
matchingId = strdup(token);
break;
case 3: // SM-DP+ OID
// ignored; this function is not implemented
break;
case 4: // Confirmation Code Required Flag
if (strncmp(token, "1", strlen(token)) == 0 && confirmation_code == NULL)
{
error_function_name = "confirmation_code";
error_detail = "required";
goto err;
}
break;
default:
break;
}
index++;
}
} }
if (smdp == NULL) if (smdp == NULL)
{ {
jprint_progress("es10a_get_euicc_configured_addresses"); jprint_progress("es10a_get_euicc_configured_addresses", NULL);
if (es10a_get_euicc_configured_addresses(&euicc_ctx, &configured_addresses)) if (es10a_get_euicc_configured_addresses(&euicc_ctx, &configured_addresses))
{ {
jprint_error("es10a_get_euicc_configured_addresses", NULL); error_function_name = "es10a_get_euicc_configured_addresses";
error_detail = NULL;
goto err; goto err;
} }
else else
@ -74,60 +166,113 @@ static int applet_main(int argc, char **argv)
if (!smdp || (strlen(smdp) == 0)) if (!smdp || (strlen(smdp) == 0))
{ {
jprint_error("smdp is null", NULL); error_function_name = "smdp";
error_detail = "empty";
goto err; goto err;
} }
signal(SIGINT, sigint_handler);
euicc_ctx.http.server_address = smdp; euicc_ctx.http.server_address = smdp;
jprint_progress("es10b_get_euicc_challenge_and_info"); CANCELPOINT();
jprint_progress("es10b_get_euicc_challenge_and_info", smdp);
if (es10b_get_euicc_challenge_and_info(&euicc_ctx)) if (es10b_get_euicc_challenge_and_info(&euicc_ctx))
{ {
jprint_error("es10b_get_euicc_challenge_and_info", NULL); error_function_name = "es10b_get_euicc_challenge_and_info";
error_detail = NULL;
goto err; goto err;
} }
jprint_progress("es9p_initiate_authentication"); CANCELPOINT();
jprint_progress("es9p_initiate_authentication", smdp);
if (es9p_initiate_authentication(&euicc_ctx)) if (es9p_initiate_authentication(&euicc_ctx))
{ {
jprint_error("es9p_initiate_authentication", euicc_ctx.http.status.message); error_function_name = "es9p_initiate_authentication";
error_detail = euicc_ctx.http.status.message;
goto err; goto err;
} }
jprint_progress("es10b_authenticate_server"); CANCELPOINT();
jprint_progress("es10b_authenticate_server", smdp);
if (es10b_authenticate_server(&euicc_ctx, matchingId, imei)) if (es10b_authenticate_server(&euicc_ctx, matchingId, imei))
{ {
jprint_error("es10b_authenticate_server", NULL); error_function_name = "es10b_authenticate_server";
error_detail = NULL;
goto err; goto err;
} }
jprint_progress("es9p_authenticate_client"); CANCELPOINT();
jprint_progress("es9p_authenticate_client", smdp);
if (es9p_authenticate_client(&euicc_ctx)) if (es9p_authenticate_client(&euicc_ctx))
{ {
jprint_error("es9p_authenticate_client", euicc_ctx.http.status.message); error_function_name = "es9p_authenticate_client";
error_detail = euicc_ctx.http.status.message;
goto err; goto err;
} }
jprint_progress("es10b_prepare_download"); // preview here
if (euicc_ctx.http._internal.prepare_download_param->b64_profileMetadata)
{
CANCELPOINT();
if (es8p_metadata_parse(&profile_metadata, euicc_ctx.http._internal.prepare_download_param->b64_profileMetadata))
{
error_function_name = "es8p_meatadata_parse";
error_detail = NULL;
goto err;
}
jmetadata = cJSON_CreateObject();
cJSON_AddStringOrNullToObject(jmetadata, "iccid", profile_metadata->iccid);
cJSON_AddStringOrNullToObject(jmetadata, "serviceProviderName", profile_metadata->serviceProviderName);
cJSON_AddStringOrNullToObject(jmetadata, "profileName", profile_metadata->profileName);
cJSON_AddStringOrNullToObject(jmetadata, "iconType", euicc_icontype2str(profile_metadata->iconType));
cJSON_AddStringOrNullToObject(jmetadata, "icon", profile_metadata->icon);
cJSON_AddStringOrNullToObject(jmetadata, "profileClass", euicc_profileclass2str(profile_metadata->profileClass));
jprint_progress_obj("es8p_meatadata_parse", jmetadata);
if (interactive_preview)
{
char c;
jprint_progress("preview", "y/n");
c = getchar();
if (c != 'y' && c != 'Y')
{
cancelled = 1;
}
}
}
CANCELPOINT();
jprint_progress("es10b_prepare_download", smdp);
if (es10b_prepare_download(&euicc_ctx, confirmation_code)) if (es10b_prepare_download(&euicc_ctx, confirmation_code))
{ {
jprint_error("es10b_prepare_download", NULL); error_function_name = "es10b_prepare_download";
error_detail = NULL;
goto err; goto err;
} }
jprint_progress("es9p_get_bound_profile_package"); CANCELPOINT();
jprint_progress("es9p_get_bound_profile_package", smdp);
if (es9p_get_bound_profile_package(&euicc_ctx)) if (es9p_get_bound_profile_package(&euicc_ctx))
{ {
jprint_error("es9p_get_bound_profile_package", euicc_ctx.http.status.message); error_function_name = "es9p_get_bound_profile_package";
error_detail = euicc_ctx.http.status.message;
goto err; goto err;
} }
jprint_progress("es10b_load_bound_profile_package"); CANCELPOINT();
jprint_progress("es10b_load_bound_profile_package", smdp);
if (es10b_load_bound_profile_package(&euicc_ctx, &download_result)) if (es10b_load_bound_profile_package(&euicc_ctx, &download_result))
{ {
char buffer[256]; char buffer[256];
snprintf(buffer, sizeof(buffer), "%s,%s", euicc_bppcommandid2str(download_result.bppCommandId), euicc_errorreason2str(download_result.errorReason)); snprintf(buffer, sizeof(buffer), "%s,%s", euicc_bppcommandid2str(download_result.bppCommandId), euicc_errorreason2str(download_result.errorReason));
jprint_error("es10b_load_bound_profile_package", buffer); error_function_name = "es10b_load_bound_profile_package";
error_detail = buffer;
goto err; goto err;
} }
@ -138,7 +283,25 @@ static int applet_main(int argc, char **argv)
err: err:
fret = -1; fret = -1;
if (error_detail)
{
error_detail = strdup(error_detail);
}
jprint_progress("es10b_cancel_session", smdp);
es10b_cancel_session(&euicc_ctx, ES10B_CANCEL_SESSION_REASON_ENDUSERREJECTION);
jprint_progress("es9p_cancel_session", smdp);
es9p_cancel_session(&euicc_ctx);
if (!cancelled)
{
jprint_error(error_function_name, error_detail);
}
else
{
jprint_error("cancelled", NULL);
}
free((void *)error_detail);
exit: exit:
es8p_metadata_free(&profile_metadata);
es10a_euicc_configured_addresses_free(&configured_addresses); es10a_euicc_configured_addresses_free(&configured_addresses);
euicc_http_cleanup(&euicc_ctx); euicc_http_cleanup(&euicc_ctx);
return fret; return fret;

View file

@ -26,12 +26,12 @@ void jprint_error(const char *function_name, const char *detail)
jstr = cJSON_PrintUnformatted(jroot); jstr = cJSON_PrintUnformatted(jroot);
cJSON_Delete(jroot); cJSON_Delete(jroot);
printf("%s\r\n", jstr); printf("%s\n", jstr);
fflush(stdout); fflush(stdout);
free(jstr); free(jstr);
} }
void jprint_progress(const char *function_name) void jprint_progress(const char *function_name, const char *detail)
{ {
cJSON *jroot = NULL; cJSON *jroot = NULL;
cJSON *jpayload = NULL; cJSON *jpayload = NULL;
@ -42,13 +42,42 @@ void jprint_progress(const char *function_name)
jpayload = cJSON_CreateObject(); jpayload = cJSON_CreateObject();
cJSON_AddNumberToObject(jpayload, "code", 0); cJSON_AddNumberToObject(jpayload, "code", 0);
cJSON_AddStringOrNullToObject(jpayload, "message", function_name); cJSON_AddStringOrNullToObject(jpayload, "message", function_name);
cJSON_AddNullToObject(jpayload, "data"); cJSON_AddStringOrNullToObject(jpayload, "data", detail);
cJSON_AddItemToObject(jroot, "payload", jpayload); cJSON_AddItemToObject(jroot, "payload", jpayload);
jstr = cJSON_PrintUnformatted(jroot); jstr = cJSON_PrintUnformatted(jroot);
cJSON_Delete(jroot); cJSON_Delete(jroot);
printf("%s\r\n", jstr); printf("%s\n", jstr);
fflush(stdout);
free(jstr);
}
void jprint_progress_obj(const char *function_name, cJSON *jdata)
{
cJSON *jroot = NULL;
cJSON *jpayload = NULL;
char *jstr = NULL;
jroot = cJSON_CreateObject();
cJSON_AddStringOrNullToObject(jroot, "type", "progress");
jpayload = cJSON_CreateObject();
cJSON_AddNumberToObject(jpayload, "code", 0);
cJSON_AddStringOrNullToObject(jpayload, "message", function_name);
if (jdata)
{
cJSON_AddItemToObject(jpayload, "data", jdata);
}
else
{
cJSON_AddNullToObject(jpayload, "data");
}
cJSON_AddItemToObject(jroot, "payload", jpayload);
jstr = cJSON_PrintUnformatted(jroot);
cJSON_Delete(jroot);
printf("%s\n", jstr);
fflush(stdout); fflush(stdout);
free(jstr); free(jstr);
} }
@ -77,7 +106,7 @@ void jprint_success(cJSON *jdata)
jstr = cJSON_PrintUnformatted(jroot); jstr = cJSON_PrintUnformatted(jroot);
cJSON_Delete(jroot); cJSON_Delete(jroot);
printf("%s\r\n", jstr); printf("%s\n", jstr);
fflush(stdout); fflush(stdout);
free(jstr); free(jstr);
} }

View file

@ -2,5 +2,6 @@
#include <cjson/cJSON_ex.h> #include <cjson/cJSON_ex.h>
void jprint_error(const char *function_name, const char *detail); void jprint_error(const char *function_name, const char *detail);
void jprint_progress(const char *function_name); void jprint_progress(const char *function_name, const char *detail);
void jprint_progress_obj(const char *function_name, cJSON *jdata);
void jprint_success(cJSON *jdata); void jprint_success(cJSON *jdata);

View file

@ -6,6 +6,7 @@
#include <time.h> #include <time.h>
#include <euicc/interface.h> #include <euicc/interface.h>
#include <euicc/hexutil.h>
#include <euicc/euicc.h> #include <euicc/euicc.h>
#include <driver.h> #include <driver.h>
@ -15,7 +16,25 @@
#include "applet/notification.h" #include "applet/notification.h"
#include "applet/version.h" #include "applet/version.h"
static int driver_applet_main(int argc, char **argv) #ifdef WIN32
#include <windef.h>
#include <processthreadsapi.h>
#include <shellapi.h>
#include <stringapiset.h>
#include <processenv.h>
#endif
#define ENV_ISD_R_AID "LPAC_CUSTOM_ISD_R_AID"
#define ISD_R_AID_MAX_LENGTH 16
#define ENV_ES10X_MSS "LPAC_CUSTOM_ES10X_MSS"
#define ES10X_MSS_MIN_VALUE 6
#define ES10X_MSS_MAX_VALUE 255
#define ENV_APDU_DRIVER "LPAC_APDU"
#define ENV_HTTP_DRIVER "LPAC_HTTP"
static int driver_applet_main(const int argc, char **argv)
{ {
const struct applet_entry *applets[] = { const struct applet_entry *applets[] = {
&(struct applet_entry){ &(struct applet_entry){
@ -48,14 +67,56 @@ static const struct applet_entry *applets[] = {
static int euicc_ctx_inited = 0; static int euicc_ctx_inited = 0;
struct euicc_ctx euicc_ctx = {0}; struct euicc_ctx euicc_ctx = {0};
void main_init_euicc() static int setup_aid(const uint8_t **aid, uint8_t *aid_len) {
*aid = NULL;
*aid_len = 0;
const char *value = getenv(ENV_ISD_R_AID);
if (value == NULL) return 0;
uint8_t *parsed = malloc(ISD_R_AID_MAX_LENGTH);
const int n = euicc_hexutil_hex2bin(parsed, ISD_R_AID_MAX_LENGTH, value);
if (n < 1) return -1;
*aid = parsed;
*aid_len = n;
return 0;
}
static int setup_mss(uint8_t *mss) {
*mss = 0;
const char *value = getenv(ENV_ES10X_MSS);
if (value == NULL) return 0;
const long parsed = strtol(value, NULL, 10);
if (parsed == 0) return 0;
if (parsed < ES10X_MSS_MIN_VALUE) return -1;
if (parsed > ES10X_MSS_MAX_VALUE) return -1;
*mss = (uint8_t) parsed;
return 0;
}
int main_init_euicc()
{ {
if (setup_aid(&euicc_ctx.aid, &euicc_ctx.aid_len))
{
jprint_error("euicc_init", "invalid custom ISD-R applet id given");
return -1;
}
if (setup_mss(&euicc_ctx.es10x_mss))
{
jprint_error("euicc_init", "invalid custom ES10x MSS given");
return -1;
}
if (euicc_init(&euicc_ctx)) if (euicc_init(&euicc_ctx))
{ {
jprint_error("euicc_init", NULL); jprint_error("euicc_init", NULL);
exit(-1); return -1;
} }
euicc_ctx_inited = 1; euicc_ctx_inited = 1;
return 0;
} }
void main_fini_euicc() void main_fini_euicc()
@ -68,13 +129,54 @@ void main_fini_euicc()
euicc_ctx_inited = 0; euicc_ctx_inited = 0;
} }
#ifdef WIN32
static char **warg_to_arg(const int wargc, wchar_t **wargv)
{
char **argv = malloc(wargc * sizeof(char *));
if (argv == NULL)
{
return NULL;
}
for (int i = 0; i < wargc; ++i)
{
const int size = WideCharToMultiByte(CP_UTF8, 0, wargv[i], -1, NULL, 0, NULL, NULL);
argv[i] = malloc(size);
if (argv[i] == NULL)
{
for (int j = 0; j < i; ++j)
{
free(argv[j]);
}
free(argv);
return NULL;
}
WideCharToMultiByte(CP_UTF8, 0, wargv[i], -1, argv[i], size, NULL, NULL);
}
return argv;
}
#endif
int main(int argc, char **argv) int main(int argc, char **argv)
{ {
int ret = 0; int ret = 0;
const char *apdu_driver;
const char *http_driver;
memset(&euicc_ctx, 0, sizeof(euicc_ctx)); memset(&euicc_ctx, 0, sizeof(euicc_ctx));
if (euicc_driver_init(getenv("LPAC_APDU"), getenv("LPAC_HTTP"))) apdu_driver = getenv(ENV_APDU_DRIVER);
if (apdu_driver == NULL)
{
apdu_driver = "pcsc";
}
http_driver = getenv(ENV_HTTP_DRIVER);
if (http_driver == NULL)
{
http_driver = "curl";
}
if (euicc_driver_init(apdu_driver, http_driver))
{ {
return -1; return -1;
} }
@ -82,6 +184,14 @@ int main(int argc, char **argv)
euicc_ctx.apdu.interface = &euicc_driver_interface_apdu; euicc_ctx.apdu.interface = &euicc_driver_interface_apdu;
euicc_ctx.http.interface = &euicc_driver_interface_http; euicc_ctx.http.interface = &euicc_driver_interface_http;
#ifdef WIN32
argv = warg_to_arg(argc, CommandLineToArgvW(GetCommandLineW(), &argc));
if (argv == NULL)
{
return -1;
}
#endif
ret = applet_entry(argc, argv, applets); ret = applet_entry(argc, argv, applets);
main_fini_euicc(); main_fini_euicc();

View file

@ -5,5 +5,5 @@
extern struct euicc_ctx euicc_ctx; extern struct euicc_ctx euicc_ctx;
void main_init_euicc(void); int main_init_euicc(void);
void main_fini_euicc(void); void main_fini_euicc(void);

View file

@ -1,655 +0,0 @@
<?php
class ShellMode extends RLPAWorkMode
{
private function lpacPrompt()
{
while (fread(STDIN, 128));
echo "lpac> ";
}
public function start($data)
{
$this->lpacPrompt();
}
public function onStdin($data)
{
$cmd = trim($data);
if ($cmd == "exit") {
throw new Exception();
}
$this->client->processOpenLpac($cmd);
}
public function onProcessFinished($data)
{
if ($data === null) {
throw new Exception();
}
print_r($data);
$this->lpacPrompt();
}
public function finished()
{
return false;
}
static public function requireStdin()
{
return true;
}
}
class ProcessNotificationMode extends RLPAWorkMode
{
private $state = 0;
private $notifications = [];
private $failed_count = 0;
public function start($data)
{
$this->state = 0;
$this->client->processOpenLpac("notification list");
}
private function processOneNotification()
{
$notification = array_shift($this->notifications);
if ($notification == null) {
if ($this->failed_count) {
$this->client->messageBox("{$this->failed_count} notifications failed to process, please retry.");
} else {
$this->client->messageBox("All notifications processed successfully.");
}
$this->state = 2;
return;
}
echo "Processing: seqNumber: {$notification['seqNumber']}, profileManagementOperation: {$notification['profileManagementOperation']}" . PHP_EOL;
switch ($notification['profileManagementOperation']) {
case 'install':
case 'enable':
case 'disable':
$this->client->processOpenLpac("notification process {$notification['seqNumber']} -r");
break;
case 'delete':
$this->client->processOpenLpac("notification process {$notification['seqNumber']}");
break;
default:
throw new Exception();
}
}
public function onProcessFinished($data)
{
if ($data === null) {
throw new Exception();
}
switch ($this->state) {
case 0:
if ($data['code'] !== 0) {
throw new Exception();
}
$this->notifications = $data['data'] ?? [];
$this->state = 1;
$this->processOneNotification();
break;
case 1:
if ($data['code'] == 0) {
echo "Process success" . PHP_EOL;
} else {
echo "Process failed" . PHP_EOL;
$this->failed_count++;
}
$this->processOneNotification();
break;
}
}
public function finished()
{
return ($this->state == 2);
}
static public function requireStdin()
{
return false;
}
}
class DownloadProfileMode extends RLPAWorkMode
{
private $state = 0;
public function start($data)
{
$this->state = 0;
$data = ltrim($data, "LPA:");
$data = explode(chr(0x02), $data); // GSM-8bit will convert $ to \x02
print_r($data);
if ($data[0] != "1") {
$this->client->messageBox("Invalid format: version mismatch");
throw new Exception();
}
if (!isset($data[1])) {
$this->client->messageBox("Invalid format: missing SM-DP+");
throw new Exception();
}
$cmd = 'profile download -s ' . escapeshellarg($data[1]);
if (isset($data[2])) {
$cmd .= ' -m ' . escapeshellarg($data[2]);
}
$this->client->processOpenLpac($cmd);
}
public function onProcessFinished($data)
{
if ($data === null) {
throw new Exception();
}
if ($data['code'] == 0) {
echo 'Download success' . PHP_EOL;
$this->client->messageBox('Download success');
} else {
print_r($data);
echo 'Download failed' . PHP_EOL;
$this->client->messageBox('Download failed');
$this->client->messageBox($data['message']);
$this->client->messageBox($data['data']);
}
$this->state = 1;
}
public function finished()
{
return ($this->state == 1);
}
static public function requireStdin()
{
return false;
}
}
class RLPAClient
{
private static $stdin_lock = false;
private $name;
private $shutdown;
private $socket;
private $packet;
private $process;
private $process_stdin;
private $process_stdout;
private $process_stderr;
/** @var RLPAWorkMode */
private $workmode;
public function __construct($socket)
{
$this->name = stream_socket_get_name($socket, true);
$this->shutdown = false;
$this->socket = $socket;
$this->packet = new RLPAPacket();
$this->process = null;
$this->process_stdin = null;
$this->process_stdout = null;
$this->process_stderr = null;
$this->workmode = null;
stream_set_blocking($socket, false);
$this->messageBox("Welcome, {$this->name}");
}
private function sendRLPAPacket($tag, $value = "")
{
if ($this->socket) {
fwrite($this->socket, (new RLPAPacket($tag, $value))->pack());
}
}
public function messageBox($msg)
{
$this->sendRLPAPacket(RLPAPacket::TAG_MESSAGEBOX, $msg);
}
public function lockAPDU()
{
$this->sendRLPAPacket(RLPAPacket::TAG_APDU_LOCK);
}
public function unlockAPDU()
{
$this->sendRLPAPacket(RLPAPacket::TAG_APDU_UNLOCK);
}
private function processPacket()
{
$work_class = null;
if ($this->packet->tag === RLPAPacket::TAG_APDU) {
if (!$this->process_stdin) {
return;
}
fwrite($this->process_stdin, json_encode(['type' => 'apdu', 'payload' => ['ecode' => 0, 'data' => bin2hex($this->packet->value)]]) . PHP_EOL);
return;
}
if ($this->workmode) {
return;
}
switch ($this->packet->tag) {
case RLPAPacket::TAG_MANAGEMNT:
$work_class = ShellMode::class;
break;
case RLPAPacket::TAG_PROCESS_NOTIFICATION:
$work_class = ProcessNotificationMode::class;
break;
case RLPAPacket::TAG_DOWNLOAD_PROFILE:
$work_class = DownloadProfileMode::class;
break;
default:
$this->messageBox("Unimplemented command.");
throw new Exception();
break;
}
if ($work_class === null) {
throw new Exception();
}
if ($work_class::requireStdin()) {
if (self::$stdin_lock) {
$this->messageBox("Already have one shell mode client");
throw new Exception();
}
stream_set_blocking(STDIN, false);
}
$this->workmode = new $work_class($this);
$this->workmode->start($this->packet->value);
}
public function onSocketRecv()
{
if ($this->workmode && $this->workmode->finished()) {
throw new Exception();
}
if ($this->shutdown) {
return;
}
$this->packet->recv($this->socket);
if (!$this->packet->isFinished()) {
return;
}
$this->processPacket();
$this->packet = new RLPAPacket();
}
public function onProcessStdout()
{
if ($this->workmode && $this->workmode->finished()) {
throw new Exception();
}
$stdout = fgets($this->process_stdout);
if (strlen($stdout) == 0) {
$this->processClose();
$this->workmode->onProcessFinished(null);
if ($this->workmode->finished()) {
throw new Exception();
}
return;
}
$request = json_decode($stdout, true);
if (!$request) {
return;
}
switch ($request['type']) {
case 'apdu':
switch ($request['payload']['func']) {
case 'connect':
fwrite($this->process_stdin, json_encode(['type' => 'apdu', 'payload' => ['ecode' => 0]]) . PHP_EOL);
break;
case 'logic_channel_open':
fwrite($this->process_stdin, json_encode(['type' => 'apdu', 'payload' => ['ecode' => 0]]) . PHP_EOL);
break;
case 'transmit':
fwrite($this->socket, (new RLPAPacket(RLPAPacket::TAG_APDU, hex2bin($request['payload']['param'])))->pack());
break;
}
break;
case 'lpa':
$this->processClose();
$this->workmode->onProcessFinished($request['payload']);
if ($this->workmode->finished()) {
throw new Exception();
}
break;
default:
// print_r($request);
break;
}
}
public function onProcessStderr()
{
if (!$this->process_stderr) {
return;
}
echo fgets($this->process_stderr);
}
public function onStdin()
{
if ($this->process !== null) {
while (fread(STDIN, 128));
return;
}
if ($this->workmode::requireStdin()) {
$this->workmode->onStdin(fgets(STDIN));
if ($this->workmode->finished()) {
throw new Exception();
}
}
}
public function getSelectable()
{
$selectable = [];
if ($this->shutdown) {
return null;
}
if ($this->socket) {
$selectable[] = [$this->socket, [$this, 'onSocketRecv']];
}
if ($this->process_stdout) {
$selectable[] = [$this->process_stdout, [$this, 'onProcessStdout']];
}
if ($this->process_stderr) {
$selectable[] = [$this->process_stderr, [$this, 'onProcessStderr']];
}
if ($this->workmode && $this->workmode::requireStdin()) {
$selectable[] = [STDIN, [$this, 'onStdin']];
}
return $selectable;
}
public function close()
{
if ($this->shutdown) {
return;
}
$this->shutdown = true;
$this->unlockAPDU();
if ($this->socket) {
$disconnect = (new RLPAPacket(RLPAPacket::TAG_CLOSE))->pack();
fwrite($this->socket, $disconnect);
stream_socket_shutdown($this->socket, STREAM_SHUT_RDWR);
$this->socket = null;
}
$this->processClose();
if ($this->workmode && $this->workmode::requireStdin()) {
self::$stdin_lock = false;
}
}
public function getName()
{
return $this->name;
}
public function processOpenLpac($cmd)
{
$this->lockAPDU();
$this->process = proc_open("./lpac {$cmd}", [['pipe', 'r'], ['pipe', 'w'], ['pipe', 'w']], $pipes, ".", ['LPAC_APDU' => 'stdio']);
$this->process_stdin = $pipes[0];
$this->process_stdout = $pipes[1];
$this->process_stderr = $pipes[2];
stream_set_blocking($this->process_stdout, false);
stream_set_blocking($this->process_stderr, false);
}
private function processClose()
{
if ($this->process_stdin) {
fclose($this->process_stdin);
$this->process_stdin = null;
}
if ($this->process_stdout) {
fclose($this->process_stdout);
$this->process_stdout = null;
}
if ($this->process_stderr) {
fclose($this->process_stderr);
$this->process_stderr = null;
}
if ($this->process) {
proc_close($this->process);
$this->process = null;
}
$this->unlockAPDU();
}
public static function resource2id($resource)
{
$id = null;
if (is_resource($resource)) {
$id = 'R' . intval($resource);
} else {
$id = 'O' . spl_object_id($resource);
}
return $id;
}
public static function getSelectableTable($clients, &$read, &$callbackTable)
{
$read = [];
$callbackTable = [];
foreach ($clients as $c) {
$rss = $c->getSelectable();
foreach ($rss as $r) {
$read[self::resource2id($r[0])] = $r[0];
$callbackTable[self::resource2id($r[0])] = $r[1];
}
}
}
}
class RLPAPacket
{
public $tag;
public $value;
private $_state;
private $_next_read_len;
private $_buffer;
public function __construct($tag = 0x00, $value = "")
{
$this->tag = $tag;
$this->value = $value;
$this->_state = 0;
$this->_next_read_len = 1;
$this->_buffer = "";
}
public function recv($socket)
{
if ($this->isFinished()) {
return;
}
$buf = stream_socket_recvfrom($socket, $this->_next_read_len);
if (strlen($buf) === 0) {
throw new \Exception();
}
$this->_next_read_len -= strlen($buf);
$this->_buffer .= $buf;
if ($this->_next_read_len === 0) {
switch ($this->_state) {
case 0:
$this->tag = unpack('C', $this->_buffer)[1];
$this->_state = 1;
$this->_next_read_len = 2;
$this->_buffer = "";
break;
case 1:
$this->_state = 2;
$this->_next_read_len = unpack('v', $this->_buffer)[1];
if ($this->_next_read_len >= (512 - 3)) {
throw new \Exception();
}
$this->_buffer = "";
if ($this->_next_read_len === 0) {
$this->_state = 3;
$this->value = "";
}
break;
case 2:
$this->_state = 3;
$this->value = $this->_buffer;
$this->_buffer = "";
break;
}
}
}
public function isFinished()
{
return ($this->_state === 3);
}
public function pack()
{
$packet = "";
$packet .= pack('C', $this->tag);
$packet .= pack('v', strlen($this->value));
$packet .= $this->value;
return $packet;
}
const TAG_MESSAGEBOX = 0x00;
const TAG_MANAGEMNT = 0x01;
const TAG_DOWNLOAD_PROFILE = 0x02;
const TAG_PROCESS_NOTIFICATION = 0x03;
const TAG_REBOOT = 0xFB;
const TAG_CLOSE = 0xFC;
const TAG_APDU_LOCK = 0xFD;
const TAG_APDU = 0xFE;
const TAG_APDU_UNLOCK = 0xFF;
}
abstract class RLPAWorkMode
{
protected $client;
public function __construct(RLPAClient $client)
{
$this->client = $client;
}
public function start($data)
{
}
public function onStdin($data)
{
}
public function onProcessFinished($data)
{
}
public function finished()
{
return true;
}
static public function requireStdin()
{
return false;
}
};
gc_enable();
$g_clients = [];
$g_server_socket = stream_socket_server("tcp://0.0.0.0:1888");
while (1) {
$read = [];
$callbackTable = [];
RLPAClient::getSelectableTable($g_clients, $read, $callbackTable);
$read['server'] = $g_server_socket;
$write = null;
$exception = null;
$ret = stream_select($read, $write, $exception, null);
foreach ($read as $key => $socket) {
if ($key === 'server') {
$accepted = stream_socket_accept($socket);
if (!$accepted) {
continue;
}
$client = new RLPAClient($accepted);
$g_clients[$client->getName()] = $client;
echo PHP_EOL . "Accepted {$client->getName()}" . PHP_EOL;
continue;
}
try {
($callbackTable[$key])();
} catch (\Exception $e) {
$instance = $callbackTable[$key][0];
$instance->close();
$name = $instance->getName();
unset($instance);
unset($g_clients[$name]);
echo PHP_EOL . "Disconnected {$name}" . PHP_EOL;
}
}
}