pySim
Open sourceActive
The GitHub repository is a mirror of the canonical gitea.osmocom.org/sim-card/pysim repository. No GitHub release was found; users are pointed to a git clone, and an Arch User Repository package is mentioned. The osmocom.org wiki page returned a bot-challenge page and was not used as a source.
pySim is a Python toolset from the Osmocom project for reading, decoding, browsing and programming SIM, UICC, USIM, ISIM, HPSIM and eUICC cards. Its main program, pySim-shell, is an interactive command line shell for the on-card filesystem; pySim-trace decodes SIM protocol traces. The documentation positions it around operators of private cellular networks who provision programmable cards, not around evidence handling, and it can write to cards when ADM credentials are available.
Facts
| Website | osmocom.org |
|---|---|
| Vendor | Osmocom project (sysmocom is named as a major contributor) and contributors |
| Licence | Open source (GPL-2.0-or-later per source-file headers (pySim-shell.py, pySim/commands.py); setup.py declares 'GPLv2'; COPYING is the GPLv2 text.) |
| Category | Utilities and libraries |
| Functions | Analysis, Decoding |
| Targets | SIM cards |
| Runs on | Linux (Python 3; the README gives Debian and Arch Linux install instructions; other operating systems are not documented) |
| Pricing | Free |
| Users | Research, Open-source DFIR community |
| Last activity | 2026-10-30 · Latest commit on the GitHub mirror (ts_102_221 life cycle status decoding fix) [github.com] |
| GitHub activity | osmocom/pysim · 607 stars · last push 2026-11-04 · checked 2026-11-10 |
Capabilities
- pySim-shell is an interactive shell for navigating the on-card filesystem, authenticating with PINs such as ADM1, managing CHV/PIN state (verify, enable, disable, unblock), and reading files in raw hex or, for files with a decoder, in decoded JSON form. [downloads.osmocom.org]
- The shell documentation lists support for classic GSM SIM, GSM-R SIM, UICC, USIM, ISIM, HPSIM and eUICC cards, including GlobalPlatform operations and listing, enabling, disabling and deleting eSIM profiles on a Consumer eUICC. [downloads.osmocom.org]
- Cards can be reached through four documented transports: a simple serial reader (Phoenix or Smart Mouse design), a PC/SC reader, a phone or modem that offers AT+CSIM generic SIM access (3GPP TS 27.007), or an OsmocomBB-compatible phone. An --apdu-trace option prints the APDUs exchanged with the card. [downloads.osmocom.org]
- The shell documentation lists export and fsdump commands: run from the MF, each output 'will contain all known files on the card' (below an ADF, only files under it), with a --json option described as 'less reliable'. The page advises entering the ADM1 PIN first to maximise the chance of permission to read all or most files, and suggests comparing fsdumps of two cards with a JSON diffing tool. [downloads.osmocom.org]
- pySim-trace.py does an in-depth decode of SIM card protocol traces such as those obtained with Osmocom SIMtrace2 or osmo-qcdiag; the README states it additionally needs tshark and the pyshark Python package. [github.com]
Limitations
- The README states that the access control configuration of normal production operator cards significantly restricts which files a user can read and particularly write, and that pySim's full functionality can only be used with programmable cards that ship with writable keys. [github.com]
- pySim-shell can write and edit card contents when the ADM PIN is available; the shell documentation page reviewed describes no read-only mode or other write-protection safeguard. [downloads.osmocom.org]
- The documentation frames the project around operators of private or custom cellular networks provisioning their own cards; it describes no forensic acquisition workflow, hashing or reporting. [downloads.osmocom.org]
- The README calls pySim-read.py and pySim-prog.py legacy tools that have 'by far been superseded by the much more capable pySim-shell.py'. [github.com]
Links
Related tools
- SIMtrace 2 · Hardware (chip-off, JTAG, ISP)
- Dekart SIM Explorer · Acquisition
Guides that discuss this tool
- SIM and eSIM forensics: what the card holds and what it does not · What a UICC/USIM stores, how card and handset data overlap, PIN/PUK limits, isolation cards, and what is publicly known about eSIM examination.
Sources
- GitHub: osmocom/pysim (README, COPYING, setup.py) (github.com)
- GitHub: pysim commit history (github.com)
- Osmocom pySim user manual: introduction (downloads.osmocom.org)
- Osmocom pySim user manual: pySim-shell (downloads.osmocom.org)
- GitHub: pysim pySim-shell.py (licence header) (github.com)
- GitHub: pysim pySim/commands.py (licence header) (github.com)
- GitHub: pysim setup.py (license field) (github.com)
- GitHub: pysim COPYING (GPLv2 text) (github.com)
Reviewed . Spotted an error? See the corrections policy.