<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/23607">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">docs: Documentation for classic pySim-{prog,read} tools<br><br>Particularly the documentation for pySim-prog is far from being<br>complete, but it's a start.<br><br>Change-Id: Ic1932e62a5d7cf33e0dd74cb071cfa7f27c6e497<br>---<br>M docs/legacy.rst<br>1 file changed, 99 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/07/23607/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/docs/legacy.rst b/docs/legacy.rst</span><br><span>index 492be46..dad83d8 100644</span><br><span>--- a/docs/legacy.rst</span><br><span>+++ b/docs/legacy.rst</span><br><span>@@ -1,2 +1,101 @@</span><br><span> Legacy tools</span><br><span> ============</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+*legacy tools* are the classic ``pySim-prog`` and ``pySim-read`` programs that</span><br><span style="color: hsl(120, 100%, 40%);">+existed long before ``pySim-shell``.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+pySim-prog</span><br><span style="color: hsl(120, 100%, 40%);">+----------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+``pySim-prog`` was the first part of the pySim software suite. It started as</span><br><span style="color: hsl(120, 100%, 40%);">+a tool to write ICCID, IMSI, MSISDN and Ki to very simplistic SIM cards, and</span><br><span style="color: hsl(120, 100%, 40%);">+was later extended to a variety of other cards. As the number of features supported</span><br><span style="color: hsl(120, 100%, 40%);">+became no longer bearable to express with command-line arguments, `pySim-shell` was</span><br><span style="color: hsl(120, 100%, 40%);">+created.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Basic use cases can still use `pySim-prog`.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Program customizable SIMs</span><br><span style="color: hsl(120, 100%, 40%);">+~~~~~~~~~~~~~~~~~~~~~~~~~</span><br><span style="color: hsl(120, 100%, 40%);">+Two modes are possible:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ - one where you specify every parameter manually :</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+``./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -i <IMSI> -s <ICCID>``</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ - one where they are generated from some minimal set :</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+``./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -z <random_string_of_choice> -j <card_num>``</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ With <random_string_of_choice> and <card_num>, the soft will generate</span><br><span style="color: hsl(120, 100%, 40%);">+ 'predictable' IMSI and ICCID, so make sure you choose them so as not to</span><br><span style="color: hsl(120, 100%, 40%);">+ conflict with anyone. (for eg. your name as <random_string_of_choice> and</span><br><span style="color: hsl(120, 100%, 40%);">+ 0 1 2 ... for <card num>).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ You also need to enter some parameters to select the device :</span><br><span style="color: hsl(120, 100%, 40%);">+ -t TYPE : type of card (supersim, magicsim, fakemagicsim or try 'auto')</span><br><span style="color: hsl(120, 100%, 40%);">+ -d DEV : Serial port device (default /dev/ttyUSB0)</span><br><span style="color: hsl(120, 100%, 40%);">+ -b BAUD : Baudrate (default 9600)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+pySim-read</span><br><span style="color: hsl(120, 100%, 40%);">+----------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+``pySim-read`` allows you to read some data from a SIM card. It will only some files</span><br><span style="color: hsl(120, 100%, 40%);">+of the card, and will only read files accessible to a normal user (without any special authentication)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Specifically, pySim-read will dump the following:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* MF</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.ICCID</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* DF.GSM</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF,IMSI</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.GID1</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.GID2</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.SMSP</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.SPN</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.PLMNsel</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.PLMNwAcT</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.OPLMNwAcT</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.HPLMNAcT</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.ACC</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.MSISDN</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.AD</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.SST</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* ADF.USIM</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.EHPLMN</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.UST</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.ePDGId</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.ePDGSelection</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* ADF.ISIM</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.PCSCF</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.DOMAIN</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.IMPI</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.IMPU</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.UICCIARI</span><br><span style="color: hsl(120, 100%, 40%);">+ * EF.IST</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+::</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ Usage: pySim-read.py [options]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ Options:</span><br><span style="color: hsl(120, 100%, 40%);">+ -h, --help show this help message and exit</span><br><span style="color: hsl(120, 100%, 40%);">+ -d DEV, --device=DEV Serial Device for SIM access [default: /dev/ttyUSB0]</span><br><span style="color: hsl(120, 100%, 40%);">+ -b BAUD, --baud=BAUD Baudrate used for SIM access [default: 9600]</span><br><span style="color: hsl(120, 100%, 40%);">+ -p PCSC, --pcsc-device=PCSC</span><br><span style="color: hsl(120, 100%, 40%);">+ Which PC/SC reader number for SIM access</span><br><span style="color: hsl(120, 100%, 40%);">+ --modem-device=DEV Serial port of modem for Generic SIM Access (3GPP TS</span><br><span style="color: hsl(120, 100%, 40%);">+ 27.007)</span><br><span style="color: hsl(120, 100%, 40%);">+ --modem-baud=BAUD Baudrate used for modem's port [default: 115200]</span><br><span style="color: hsl(120, 100%, 40%);">+ --osmocon=PATH Socket path for Calypso (e.g. Motorola C1XX) based</span><br><span style="color: hsl(120, 100%, 40%);">+ reader (via OsmocomBB)</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/23607">change 23607</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/pysim/+/23607"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: pysim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ic1932e62a5d7cf33e0dd74cb071cfa7f27c6e497 </div>
<div style="display:none"> Gerrit-Change-Number: 23607 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>