|
1 |
| -pySim - Read, Write and Browse Programmable SIM/USIM/ISIM/HPSIM Cards |
2 |
| -===================================================================== |
3 |
| - |
4 |
| -This repository contains a number of Python programs that can be used |
5 |
| -to read, program (write) and browse all fields/parameters/files on |
6 |
| -SIM/USIM/ISIM/HPSIM cards used in 3GPP cellular networks from 2G to 5G. |
| 1 | +pySim - Tools for reading, decoding, browsing SIM/USIM/ISIM/HPSIM/eUICC Cards |
| 2 | +============================================================================= |
| 3 | + |
| 4 | +This repository contains a number of Python programs related to working with |
| 5 | +subscriber identity modules of cellular networks, including but not limited |
| 6 | +to SIM, UICC, USIM, ISIM, HPSIMs and eUICCs. |
| 7 | + |
| 8 | +* `pySim-shell.py` can be used to interactively explore, read and decode contents |
| 9 | + of any of the supported card models / card applications. Furthermore, if |
| 10 | + you have the credentials to your card (ADM PIN), you can also write to the card, |
| 11 | + i.e. edit its contents. |
| 12 | +* `pySim-read.py` and `pySim-prog.py` are _legacy_ tools for batch programming |
| 13 | + some very common parameters to an entire batch of programmable cards |
| 14 | +* `pySim-trace.py` is a tool to do an in-depth decode of SIM card protocol traces |
| 15 | + such as those obtained by [Osmocom SIMtrace2](https://osmocom.org/projects/simtrace2/wiki) |
| 16 | + or [osmo-qcdiag](https://osmocom.org/projects/osmo-qcdiag/wiki). |
| 17 | +* `osmo-smdpp.py` is a proof-of-concept GSMA SGP.22 Consumer eSIM SM-DP+ for lab/research |
| 18 | +* there are more related tools, particularly in the `contrib` directory. |
7 | 19 |
|
8 | 20 | Note that the access control configuration of normal production cards
|
9 | 21 | issue by operators will restrict significantly which files a normal
|
10 | 22 | user can read, and particularly write to.
|
11 | 23 |
|
12 | 24 | The full functionality of pySim hence can only be used with on so-called
|
13 |
| -programmable SIM/USIM/ISIM/HPSIM cards. |
| 25 | +programmable SIM/USIM/ISIM/HPSIM cards, such as the various |
| 26 | +[sysmocom programmable card products](https://shop.sysmocom.de/SIM/). |
14 | 27 |
|
15 | 28 | Such SIM/USIM/ISIM/HPSIM cards are special cards, which - unlike those
|
16 | 29 | issued by regular commercial operators - come with the kind of keys that
|
@@ -49,9 +62,9 @@ pySim-shell vs. legacy tools
|
49 | 62 | ----------------------------
|
50 | 63 |
|
51 | 64 | While you will find a lot of online resources still describing the use of
|
52 |
| -pySim-prog.py and pySim-read.py, those tools are considered legacy by |
| 65 | +`pySim-prog.py` and `pySim-read.py`, those tools are considered legacy by |
53 | 66 | now and have by far been superseded by the much more capable
|
54 |
| -pySim-shell. We strongly encourage users to adopt pySim-shell, unless |
| 67 | +`pySim-shell.py`. We strongly encourage users to adopt pySim-shell, unless |
55 | 68 | they have very specific requirements like batch programming of large
|
56 | 69 | quantities of cards, which is about the only remaining use case for the
|
57 | 70 | legacy tools.
|
|
0 commit comments