python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming.
Go to file
Philipp Maier 76db7d7295 Fairwaves-SIM: Add test data
Add test-data in order to be able to run our hardware read/write tests on
Fairwaves-SIM as well.

Change-Id: I04713e8cb1098521eafa4594100fcc7226978e21
2019-11-12 13:36:22 +01:00
contrib Add support for automatic card handling 2019-09-12 11:21:47 +02:00
pySim do not use spaces in card names 2019-11-11 11:03:19 +01:00
pysim-testdata Fairwaves-SIM: Add test data 2019-11-12 13:36:22 +01:00
tests pySim-prog: Add option for hex ADM keys 2019-09-03 20:11:48 +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 readme: add 'serial' dep, cosmetically rearrange 2018-08-20 21:54:34 +02:00
csv-format pySim-prog: Use CSV format with headers 2019-09-03 20:11:48 +02:00 python3 conversion: fix tabs and spaces inconsistency 2019-09-15 15:53:02 +02:00 python3 conversion: fix tabs and spaces inconsistency 2019-09-15 15:53:02 +02: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)

Example for Debian:

apt-get install python-pyscard python-serial python-pip
pip install pytlv

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

print sc.run_gsm('00112233445566778899aabbccddeeff')