sim-card
/
pysim
mirror of https://gerrit.osmocom.org/pysim
10
0
Fork 1
Code Issues Releases Wiki Activity
python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming. https://osmocom.org/projects/pysim
1,129 Commits 21 Branches 1 Tag 12 MiB
Python 99.2%
Shell 0.8%
Go to file
Harald Welte 1d1ba8e4cc esim.esp2: Allow HTTP methods other than POST 
While all official/standardized ES2+ API functions use POST, there
are some vendor-specific extensions using different HTTP methods.  Be
flexible enough to allow derived classes to easily specify other methods.

Change-Id: I4b1a0dc7e6662485397c7708933bf16e5ed56e10
 		2024-04-03 00:49:33 +02:00
.github Add funding link to github mirror 2024-03-23 09:22:55 +00:00
contrib contrib/jenkins.sh: add 'distcheck' job to check package integrity 2024-03-21 18:39:00 +00:00
docs docs/shell: Give users some hints on what to do if encoding/decoding fails 2024-03-11 12:55:29 +01:00
pySim esim.esp2: Allow HTTP methods other than POST 2024-04-03 00:49:33 +02:00
pysim-testdata ts_31_103: Add construct for EF.GBABP and EF.GBANL 2024-01-04 21:27:39 +01:00
scripts scripts/deactivate-5g.script: Also disable service 126 2022-07-08 20:47:35 +02:00
smdpp-data osmo-smdpp: Add TS.48 profiles modified for unique ICCIDs 2024-02-21 09:22:40 +01:00
tests tests: assertEquals() is deprecated, use assertEqual() 2024-03-02 01:36:19 +07:00
.checkpatch.conf Initial proof-of-concept SM-DP+ for GSMA consumer eSIM RSP 2024-01-09 21:37:12 +00:00
.gitignore gitignore: add manuals related files 2023-03-20 13:30:38 +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.md README.md: Add link to issue tracker 2024-03-23 10:06:48 +01:00
csv-format pySim-prog: Use CSV format with headers 2019-09-03 20:11:48 +02:00
osmo-smdpp.py osmo-smdpp: fix generation of transactionId 2024-03-15 09:27:36 +01:00
pySim-prog.py pySim-prog: convert from optparse to argparse 2024-03-15 20:33:09 +00:00
pySim-read.py transport: do not catch exceptions in init_reader 2023-10-16 14:36:02 +02:00
pySim-shell.py pySim-shell: Fix regression in 'apdu' command on cards without profile 2024-02-05 17:54:51 +01:00
pySim-trace.py Allow logger to do lazy evaluation of format strings 2024-01-08 12:10:11 +00:00
pyproject.toml Introduce setuptools support 2021-04-04 10:54:46 +02:00
requirements.txt requirements.txt: Switch to osmocom fork of asn1tools 2024-01-29 09:21:57 +01:00
setup.cfg Use README.md as long description in package metadata 2021-08-03 08:38:55 -07:00
setup.py add missing modules to setup.py 2024-03-20 15:01:46 -07:00

README.md

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

This repository contains a number of Python programs that can be used to read, program (write) and browse all fields/parameters/files on SIM/USIM/ISIM/HPSIM cards used in 3GPP cellular networks from 2G to 5G.

Note that the access control configuration of normal production cards issue by operators will restrict significantly which files a normal user can read, and particularly write to.

The full functionality of pySim hence can only be used with on so-called programmable SIM/USIM/ISIM/HPSIM cards.

Such SIM/USIM/ISIM/HPSIM 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 configure your own SIM/USIM/ISIM/HPSIM cards for that network.

Homepage

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

Documentation

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 https://downloads.osmocom.org/docs/latest/pysim/ and a downloadable PDF version is published at https://downloads.osmocom.org/docs/latest/osmopysim-usermanual.pdf.

A slightly dated video presentation about pySim-shell can be found at https://media.ccc.de/v/osmodevcall-20210409-laforge-pysim-shell.

pySim-shell vs. legacy tools

While you will find a lot of online resources still describing the use of pySim-prog.py and pySim-read.py, 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.

Git Repository

You can clone from the official Osmocom git repository using

git clone https://gitea.osmocom.org/sim-card/pysim.git

There is a web interface at https://gitea.osmocom.org/sim-card/pysim.

Installation

Please install the following dependencies:

  • bidict
  • cmd2 >= 1.5.0
  • colorlog
  • construct >= 2.9.51
  • gsm0338
  • jsonpath-ng
  • packaging
  • pycryptodomex
  • pyscard
  • pyserial
  • pytlv
  • pyyaml >= 5.1
  • smpp.pdu (from github.com/hologram-io/smpp.pdu)
  • termcolor

Example for Debian:

sudo apt-get install --no-install-recommends \
	pcscd libpcsclite-dev \
	python3 \
	python3-setuptools \
	python3-pycryptodome \
	python3-pyscard \
	python3-pip
pip3 install --user -r requirements.txt

After installing all dependencies, the pySim applications pySim-read.py, pySim-prog.py and pySim-shell.py may be started directly from the cloned repository.

In addition to the dependencies above pySim-trace.py requires tshark and the python package pyshark to be installed. It is known that the tshark package in Debian versions before 11 may not work with pyshark.

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

Forum

We welcome any pySim related discussions in the SIM Card Technology section of the osmocom discourse (web based Forum).

Mailing List

There is no separate mailing list for this project. However, discussions related to pySim are happening on the simtrace simtrace@lists.osmocom.org mailing list, please see https://lists.osmocom.org/mailman/listinfo/simtrace for subscription options and the list archive.

Please observe the Osmocom Mailing List Rules when posting.

Issue Tracker

We use the issue tracker of the pysim project on osmocom.org for tracking the state of bug reports and feature requests. Feel free to submit any issues you may find, or help us out by resolving existing issues.

Contributing

Our coding standards are described at https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards

We are using a gerrit-based patch review process explained at https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit