Skip to content

Commit 16920ae

Browse files
committed
README.md update / re-wording
Let's give a better description of what the project is all about, and differentiate reading/exploring any SIM from writing/updating a special programmable one where you know the ADM credentials. Change-Id: Ied2a9626594e9735d92d4eabe6c6b90f92aa2909
1 parent 67c0fff commit 16920ae

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
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.
719

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

1224
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/).
1427

1528
Such SIM/USIM/ISIM/HPSIM cards are special cards, which - unlike those
1629
issued by regular commercial operators - come with the kind of keys that
@@ -49,9 +62,9 @@ pySim-shell vs. legacy tools
4962
----------------------------
5063

5164
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
5366
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
5568
they have very specific requirements like batch programming of large
5669
quantities of cards, which is about the only remaining use case for the
5770
legacy tools.

0 commit comments

Comments
 (0)