python libraires and command line tools for SIM/UICC/USIM/ISIM card analysis and programming. https://osmocom.org/projects/pysim
Go to file
Vadim Yanitskiy 4ae7c49076 pySim/utils_test.py: prepare this to be executed on Jenkins
As it turns out, we had this set of unit tests since 2018, but
so far they were not executed during the build verification.

Let's fix this:

  * run unittest in discovery mode for all files in 'tests/' (commented out);
  * rename this file, so it can be automatically detected and executed;
  * properly import the API to be tested.

Currently 2 out of 16 unit tests are failing, so we need to get
them passing first and then uncomment the unittest execution.

Change-Id: I4d4facfabc75187acd5238ff4d0f26022bd58f82
2021-03-11 23:54:15 +01:00
contrib pySim/utils_test.py: prepare this to be executed on Jenkins 2021-03-11 23:54:15 +01:00
pySim pySim/utils_test.py: prepare this to be executed on Jenkins 2021-03-11 23:54:15 +01:00
pysim-testdata pySim-read.py: Enable reading of UICC IARI from ISIM 2021-01-05 15:59:38 +01:00
tests pySim/utils_test.py: prepare this to be executed on Jenkins 2021-03-11 23:54:15 +01: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
README.md Readme.md: update debian deps, add python3-yaml 2021-01-20 19:04:41 +01:00
csv-format pySim-prog: Use CSV format with headers 2019-09-03 20:11:48 +02:00
pySim-prog.py Python 2 is deprecated, remove backwards compatibility chunks 2021-03-07 20:33:46 +01:00
pySim-read.py utils: catch exceptions during reader initalitation 2021-02-25 15:16:07 +01:00
pySim-shell.py Add a new pySim-shell program 2021-03-03 08:43:38 +01:00

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)

Example for Debian:

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

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'))