forked from public/pysim
fc932a2ee9
Add a Sphinx extension (docs/pysim_fs_sphinx.py) that hooks into the builder-inited event and generates docs/filesystem.rst before Sphinx reads any source files. The generated page contains a hierarchical listing of all implemented EFs and DFs, organised by application/specification (UICC/TS 102 221, ADF.USIM/TS 31.102, ADF.ISIM/TS 31.103, SIM/TS 51.011). For each file, the class docstring and any _test_de_encode / _test_decode vectors are included as an encoding/decoding example table. docs/filesystem.rst is fully generated at build time and is therefore added to .gitignore. Add tests/unittests/test_fs_coverage.py that walks all pySim.* modules and verifies that every CardProfile, CardApplication, and standalone CardDF subclass with EF/DF children is either listed in the SECTIONS (and will appear in the docs) or explicitly EXCLUDED. Change-Id: I06ddeefc6c11e04d7c24e116f3f39c8a6635856f Related: OS#6316
61 lines
1.9 KiB
ReStructuredText
61 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
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|