mirror of
https://gitea.osmocom.org/sim-card/pysim.git
synced 2026-06-24 08:48:30 +03:00
Philipp Maier
efe6e32120
Problem: When UICC/eUICC cards are deployed into the field it is often difficult to perform modifications to those cards. One important factor that makes after-deployment modifications often difficult is that the key material needed to perform the task must not be handed to the card holder due to security requirements. The presented Remote Card Procedure Framework solves this problem. It provides a so called Remote Card Procedure Client (RCPC), which is a lightwight software client which can be run by the card holder on the remote machine. With the RCPC, the card holder can access a so called Remote Card Procedure Server (RCPC), to which so called Remote Card Procedure Modules (RCPM) can subscribe and publish their functionality. With the RCPC, the card holder can browse the functionality offered by those connected modules and eventually the card holder may execute a certain procedure by passing a command to the RCPS. When a procedure is carried out, the RCPS automatically retrieves the required key material from a database or CSV file and passes those keys on to the selected RCPM. The RCPM can then use the key material to establish a secure channel to carry out the procedure. The procedure is then protected by a secure channel and the key material is never disclosed towards the card holder on the remote end. The framework is desinged in such a way that existing pySim APIs and functions can be used from the RCPM API user code. Also only minimal boilerplate code is required. The implementation also ships with a comprehensive example. Related: SYS#6959
62 lines
1.9 KiB
ReStructuredText
62 lines
1.9 KiB
ReStructuredText
.. pysim documentation master file
|
|
|
|
Welcome to Osmocom pySim
|
|
========================
|
|
|
|
Introduction
|
|
------------
|
|
|
|
pySim is a python implementation of various software that helps you with
|
|
managing subscriber identity cards for cellular networks, so-called SIM
|
|
cards.
|
|
|
|
Many Osmocom (Open Source Mobile Communications) projects relate to operating
|
|
private / custom cellular networks, and provisioning SIM cards for said networks
|
|
is in many cases a requirement to operate such networks.
|
|
|
|
To make use of most of pySim's features, you will need a `programmable` SIM card,
|
|
i.e. a card where you are the owner/operator and have sufficient credentials (such
|
|
as the `ADM PIN`) in order to write to many if not most of the files on the card.
|
|
|
|
Such cards are, for example, available from sysmocom, a major contributor to pySim.
|
|
See https://www.sysmocom.de/products/lab/sysmousim/ for more details.
|
|
|
|
pySim supports classic GSM SIM cards as well as ETSI UICC with 3GPP USIM and ISIM
|
|
applications. It is easily extensible, so support for additional files, card
|
|
applications, etc. can be added easily by any python developer. We do encourage you
|
|
to submit your contributions to help this collaborative development project.
|
|
|
|
pySim consists of several parts:
|
|
|
|
* a python :ref:`library<pySim library>` containing plenty of objects and methods that can be used for
|
|
writing custom programs interfacing with SIM cards.
|
|
* the [new] :ref:`interactive pySim-shell command line program<pySim-shell>`
|
|
* the [new] :ref:`pySim-trace APDU trace decoder<pySim-trace>`
|
|
* the [legacy] :ref:`pySim-prog and pySim-read tools<Legacy tools>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: Contents:
|
|
|
|
shell
|
|
filesystem
|
|
trace
|
|
legacy
|
|
smpp2sim
|
|
library
|
|
library-esim
|
|
osmo-smdpp
|
|
sim-rest
|
|
suci-keytool
|
|
saip-tool
|
|
smpp-ota-tool
|
|
rcpf
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|