# Onomondo eIM
onomondo-eim is an erlang based eIM (Remote provisioning and management of the eUICC in IoT Devices, see also SGP.31)
implementation. Besides an ES9+ (SMDP+) and an ESipa (IPAd) interface it also features a REST API that allows an API
user to perform management tasks on the eUICC (profile download, execution of PSMOs, eCOs and eUICC data requests).

This code currently implements SGP.32 v1.0, an early version
of the GSMA specifications which did never get used in production.  The only SAS-SM accredited eUICCs
implemented the later SGP.32 v1.2. For differences, see
this [summary of SGP.32 changes](https://osmocom.org/projects/sim-card-related/wiki/GSMA_SGP32_ChangeLog).

Interfaces
----------

### ESipa

The ESipa interface of onomondo-eim is implemented as an HTTP server interface (see also GSMA SGP.32, section 6.1) that
uses ASN.1 function bindings (see also GSMA SGP.32, section 6.3. The HTTP client (IPAd) on the remote end is expected to
establish the connection with the ESipa.GetEimPackage request and keep it open at least until the related procedure
ends with the ESipa.HandleNotifications request (see also GSMA SGP.32, section 3.1.1.1, figure 5)

### ES9+

The ES9+ interface of onomondo-eim is implemented as a HTTP client interface (see also GSMA SGP.22, section 5.6). that
uses the JSON function bindings (see also GSMA SGP.22, section 6.5).

### REST API

The REST API is a custom interface that is used by the eIM operator to manage a fleet of eUICCs. It is implemented
as a HTTP server and uses JSON formatted requests and responses. (see also section `REST API`)


Getting Started
---------------

### Installing run time dependencies

Required to compile and run the onomondo_eim erlang application:

    * erlang
    * rebar3

A `.tool-versions` file is included for version specification, and can be used
with: 

* [asdf](https://asdf-vm.com/guide/getting-started.html)
    * [asdf-erlang](https://github.com/asdf-vm/asdf-erlang)
    * [asdf-rebar](https://github.com/Stratus3D/asdf-rebar)

Required to compile and run the restop.py tool:

* python3
  * [erlang-py](https://pypi.org/project/erlang-py/)
  * [requests](https://pypi.org/project/requests/)

```
  pip3 install erlang-py
  pip3 install requests
```

Documentation
-------------

* [Build](doc/build.md)
* [REST API](doc/rest_api.md)
* [Database](doc/database.md)
* [Examples](doc/examples.md)