python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming.
Go to file
Harald Welte 23198c4e90 sim-rest-server: Add example systemd service/unit file
the sim-rest-server is a minimal HTTP/RESTful API for performing
UMTS-AKA against a SIM card inserted in a locally reachable PC/SC
reader.  Let's add s systemd service/unit file for people wanting to
run this service from systemd.

Change-Id: I84b390af09d33de2c740898ff3d7d5a90a300588
2021-11-03 12:50:15 +01:00
contrib sim-rest-server: Add example systemd service/unit file 2021-11-03 12:50:15 +01:00
docs pySim-shell: Improve documentation 2021-10-21 14:41:43 +02:00
pySim ts_51_011: implement CardProfileSIM as a class 2021-10-29 18:51:28 +02:00
pysim-testdata pySim-read: adjust meaning of HPLMN/OPLMN flags in EF_SPN 2021-05-23 10:06:08 +00:00
scripts/sysmoISIM-SJA2 pySim-shell: add example script to dump authentication config 2021-10-16 10:46:05 +02:00
tests utils: COMPREHENSION-TLV support 2021-05-29 22:13:56 +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 update readme detail about cmd2 - make sure people get 1.5 from pip instead of some old debian-pkg 2021-08-27 17:14:52 +02:00
csv-format pySim-prog: Use CSV format with headers 2019-09-03 20:11:48 +02:00 pySim-prog: fix typo 2021-10-01 18:11:29 +02:00 cards: rename class "Card" to "SimCard" 2021-06-30 08:17:12 +00:00 pySim-shell: Improve documentation 2021-10-21 14:41:43 +02:00
pyproject.toml Introduce setuptools support 2021-04-04 10:54:46 +02:00
requirements.txt cmd2: Constrain version to >= 1.3.0 but < 2.0.0 2021-06-11 23:47:26 +02:00
setup.cfg Use as long description in package metadata 2021-08-03 08:38:55 -07:00 cmd2: Constrain version to >= 1.3.0 but < 2.0.0 2021-06-11 23:47:26 +02:00

pySim - Read, Write and Browse Programmable SIM/USIM Cards

This repository contains Python programs that can be used to read, program (write) and browse 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.

Homepage and Manual

Please visit the official homepage for usage instructions, manual and examples.

Git Repository

You can clone from the official Osmocom git repository using

git clone git://

There is a cgit interface at


Please install the following dependencies:

  • pyscard
  • serial
  • pytlv
  • cmd2 >= 1.3.0 but < 2.0.0
  • jsonpath-ng
  • construct
  • bidict
  • gsm0338

Example for Debian:

apt-get install python3-pyscard python3-serial python3-pip python3-yaml
pip3 install -r requirements.txt

After installing all dependencies, the pySim applications, and may be started directly from the cloned repository.

Archlinux Package

Archlinux users may install the package python-pysim-git from the Arch User Repository (AUR). The most convenient way is the use of an AUR Helper, e.g. yay or pacaur. The following example shows the installation with yay.

# Install
yay -Sy python-pysim-git

# Uninstall
sudo pacman -Rs python-pysim-git

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 using a gerrit-based patch review process explained at

Usage Examples

  • Program customizable SIMs. Two modes are possible:
  • one where you specify every parameter manually:
./ -n 26C3 -c 49 -x 262 -y 42 -i <IMSI> -s <ICCID>
  • 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 e.g. 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 (e.g. ipython):
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