Vadim Yanitskiy
c8458e2477
The bug that was attempted to be fixed in [1] actually was in the encoding API - pySim.utils.enc_plmn(). According to 3GPP TS 31.102, which points to TS 24.008, the three-digit (E)HPLMN shall be encoded as shown below (ASCII-art interpretation): 0 1 2 3 4 5 6 7 +---+---+---+---+---+---+---+---+ | MCC Digit 2 | MCC Digit 1 | +---+---+---+---+---+---+---+---+ | MNC Digit 3 | MCC Digit 3 | +---+---+---+---+---+---+---+---+ | MNC Digit 2 | MNC Digit 1 | +---+---+---+---+---+---+---+---+ while pySim.utils.enc_plmn() would produce the following: 0 1 2 3 4 5 6 7 +---+---+---+---+---+---+---+---+ | MCC Digit 2 | MCC Digit 1 | +---+---+---+---+---+---+---+---+ | MNC Digit 1 | MCC Digit 3 | +---+---+---+---+---+---+---+---+ | MNC Digit 3 | MNC Digit 2 | +---+---+---+---+---+---+---+---+ Initially the _decoding_ API was correct, but then got changed in [1] to follow buggy pySim's encoding API. As a result, a (E)HPLMN programmed with pySim-prog.py would look correct if verified by pySim-read.py, but the actual file content would be wrong. This situation shows that our 'program-read-match' build verification approach alone is insignificant. The lack of unit test coverage, at least for the core parts of the project, makes it possible to have symmetrical bugs in both encoding and decoding API parts unnoticed. This problem was found while trying to enable dead unit tests in [3]. Change [1] that introduced a symmetrical bug is reverted in [2]. Change-Id: Ic7612502e1bb0d280133dabbcb5cb146fc6997e5 Related: [1] I799469206f87e930d8888367890babcb8ebe23a9 Related: [2] If6bf5383988ad442e275efc7c5a159327d104879 Related: [3] I4d4facfabc75187acd5238ff4d0f26022bd58f82 |
||
---|---|---|
contrib | ||
pySim | ||
pysim-testdata | ||
tests | ||
.gitignore | ||
.gitreview | ||
COPYING | ||
README.md | ||
csv-format | ||
pySim-prog.py | ||
pySim-read.py | ||
pySim-shell.py |
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'))