python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming.
Go to file
Harald Welte 94e8735bd3 Use sphinx for generating documentation
This adds sphinx based documentation generation.  For now,
this manily renders some introduction and the autodoc-genreated
class/method reference from the source code for our libraries.

Actual user-level documentation for pySim-{prog,shell,read} remains
to be added separately

Change-Id: I52603e93c2c129a9e79687da6c534fa56a40a649
2021-04-02 21:08:51 +02:00
contrib contrib/ enable automatic execution of unit tests 2021-03-12 01:13:15 +01:00
docs Use sphinx for generating documentation 2021-04-02 21:08:51 +02:00
pySim Add more documentation to the classes/methods 2021-04-02 21:08:35 +02:00
pysim-testdata Enable reading of UICC IARI from ISIM 2021-01-05 15:59:38 +01:00
tests Add decoder/encoder for EF.SUCI_Calc_Info 2021-04-02 14:10:10 +02:00
.gitignore Add README, COPYING, .gitignor 2009-12-27 09:43:51 +01:00
.gitreview add .gitreview 2018-07-19 23:51:00 +02:00
COPYING Add README, COPYING, .gitignor 2009-12-27 09:43:51 +01:00 Check in requirements.txt to simplify installing dependencies 2021-03-12 15:45:44 +01:00
csv-format pySim-prog: Use CSV format with headers 2019-09-03 20:11:48 +02:00 Python 2 is deprecated, remove backwards compatibility chunks 2021-03-07 20:33:46 +01:00 fileystem: fix ADF selection 2021-04-02 16:21:14 +02:00 pySim-shell: fix and improve file system exporter 2021-04-02 16:32:53 +02:00
requirements.txt Check in requirements.txt to simplify installing dependencies 2021-03-12 15:45:44 +01:00

pySim-prog - Utility for programmable SIM/USIM-Cards

This repository contains a Python-language program that can be used to program (write) certain fields/parameters on so-called programmable SIM/USIM cards.

Such SIM/USIM cards are special cards, which - unlike those issued by regular commercial operators - come with the kind of keys that allow you to write the files/fields that normally only an operator can program.

This is useful particularly if you are running your own cellular network, and want to issue your own SIM/USIM cards for that network.


The official homepage of the project is

GIT Repository

You can clone from the official libosmocore.git repository using

git clone git://

There is a cgit interface at


pysim requires:

  • pyscard
  • serial
  • pytlv (for specific card types)
  • cmd2 (for

Example for Debian:

apt-get install python3-pyscard python3-serial python3-cmd2 python3-pip python3-yaml
pip3 install pytlv

Alternatively, everything can be installed using pip:

pip3 install -r requirements.txt

Mailing List

There is no separate mailing list for this project. However, discussions related to pysim-prog are happening on the mailing list, please see for subscription options and the list archive.

Please observe the Osmocom Mailing List Rules when posting.


Our coding standards are described at

We are currently accepting patches by e-mail to the above-mentioned mailing list.


  • Program customizable SIMs. Two modes are possible:
  • one where you specify every parameter manually :

./ -n 26C3 -c 49 -x 262 -y 42 -i -s

  • one where they are generated from some minimal set :

./ -n 26C3 -c 49 -x 262 -y 42 -z <random_string_of_choice> -j <card_num>

With <random_string_of_choice> and <card_num>, the soft will generate
'predictable' IMSI and ICCID, so make sure you choose them so as not to
conflict with anyone. (for eg. your name as <random_string_of_choice> and
0 1 2 ... for <card num>).

You also need to enter some parameters to select the device : -t TYPE : type of card (supersim, magicsim, fakemagicsim or try 'auto') -d DEV : Serial port device (default /dev/ttyUSB0) -b BAUD : Baudrate (default 9600)

  • Interact with SIMs from a python interactive shell (ipython for eg :)

from pySim.transport.serial import SerialSimLink from pySim.commands import SimCardCommands

sl = SerialSimLink(device='/dev/ttyUSB0', baudrate=9600) sc = SimCardCommands(sl)


# Print IMSI

print(sc.read_binary(['3f00', '7f20', '6f07']))

# Run A3/A8