python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming. https://osmocom.org/projects/pysim
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.
 
 
Harald Welte 9813dc958b Introduce setuptools support 2 years ago
contrib jenkins.sh: Build documentation as part of build verification 2 years ago
docs docs: Initial documentation for pySim-shell 2 years ago
pySim transport: Pass status word interpreter to exception handler 2 years ago
pysim-testdata pySim-read.py: Enable reading of UICC IARI from ISIM 2 years ago
tests Add decoder/encoder for EF.SUCI_Calc_Info 2 years ago
.gitignore Add README, COPYING, .gitignor 13 years ago
.gitreview add .gitreview 5 years ago
COPYING Add README, COPYING, .gitignor 13 years ago
README.md Check in requirements.txt to simplify installing dependencies 2 years ago
csv-format pySim-prog: Use CSV format with headers 3 years ago
pySim-prog.py Move init_reader() from utils.py to transport/__init__.py 2 years ago
pySim-read.py Move init_reader() from utils.py to transport/__init__.py 2 years ago
pySim-shell.py transport: Pass status word interpreter to exception handler 2 years ago
pyproject.toml Introduce setuptools support 2 years ago
requirements.txt Check in requirements.txt to simplify installing dependencies 2 years ago
setup.py Introduce setuptools support 2 years ago

README.md

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.

Homepage

The official homepage of the project is http://osmocom.org/projects/pysim/wiki

GIT Repository

You can clone from the official libosmocore.git repository using

git clone git://git.osmocom.org/pysim.git

There is a cgit interface at http://git.osmocom.org/pysim/

Dependencies

pysim requires:

  • pyscard
  • serial
  • pytlv (for specific card types)
  • cmd2 (for pySim-shell.py)

Example for Debian:

apt-get install python3-pyscard python3-serial python3-cmd2 python3-pip python3-yaml
pip3 install pytlv

Alternatively, everything can be installed using pip:

pip3 install -r requirements.txt

Mailing List

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

Please observe the Osmocom Mailing List Rules when posting.

Contributing

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

We are currently accepting patches by e-mail to the above-mentioned mailing list.

Usage

  • Program customizable SIMs. Two modes are possible:
  • one where you specify every parameter manually :

./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -i -s

  • one where they are generated from some minimal set :

./pySim-prog.py -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)

sl.wait_for_card()

# Print IMSI

print(sc.read_binary(['3f00', '7f20', '6f07']))

# Run A3/A8

print(sc.run_gsm('00112233445566778899aabbccddeeff'))