python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Harald Welte 8dbf714e96
gsm_r: Fix decoding of EF.FN
5 months ago
contrib contrib/ split test/pylint/docs 7 months ago
docs docs: allow overriding OSMO_GSM_MANUALS_DIR 8 months ago
pySim gsm_r: Fix decoding of EF.FN 5 months ago
pysim-testdata add missing bit definition for NG-RAN in xAcT 1 year ago
scripts scripts/deactivate-5g.script: Also disable service 126 11 months ago
tests Add new pySim.ota library, implement SIM OTA crypto 9 months ago
.gitignore Add README, COPYING, .gitignor 14 years ago
.gitreview add .gitreview 5 years ago
COPYING Add README, COPYING, .gitignor 14 years ago update installation instructions for Debian 9 months ago
csv-format pySim-prog: Use CSV format with headers 4 years ago pySim-prog: add python docstring for read_params_csv 6 months ago cosmetic: Switch to consistent four-spaces indent; run autopep8 1 year ago pySim-shell: Use definitions to print decoded proactive cmds 10 months ago pySim-trace: Add support for reading GSMTAP from pcap files 5 months ago
pyproject.toml Introduce setuptools support 2 years ago
requirements.txt Add new pySim.ota library, implement SIM OTA crypto 9 months ago
setup.cfg Use as long description in package metadata 2 years ago Add new pySim.ota library, implement SIM OTA crypto 9 months ago

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. The user manual can also be built locally from this source code by cd docs && make html latexpdf for HTML and PDF format, respectively.

Git Repository

You can clone from the official Osmocom git repository using

git clone

There is a web interface at


Please install the following dependencies:

  • pyscard
  • pyserial
  • pytlv
  • cmd2 >= 1.3.0 but < 2.0.0
  • jsonpath-ng
  • construct >= 2.9.51
  • bidict
  • gsm0338
  • pyyaml >= 5.1
  • termcolor
  • colorlog

Example for Debian:

sudo apt-get install --no-install-recommends \
	pcscd libpcsclite-dev \
	python3 \
	python3-setuptools \
	python3-pyscard \
pip3 install --user -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


The pySim user manual can be built from this very source code by means of sphinx (with sphinxcontrib-napoleon and sphinx-argparse). See the Makefile in the 'docs' directory.

A pre-rendered HTML user manual of the current pySim 'git master' is available from and a downloadable PDF version is published at

A slightly dated video presentation about pySim-shell can be found at

pySim-shell vs. legacy tools

While you will find a lot of online resources still describing the use of and, those tools are considered legacy by now and have by far been superseded by the much more capable pySim-shell. We strongly encourage users to adopt pySim-shell, unless they have very specific requirements like batch programming of large quantities of cards, which is about the only remaining use case for the legacy tools.