<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/16946">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
laforge: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">pySim-prog.py: add support for MSISDN programming<br><br>This change implements programming of EF.MSISDN as per 3GPP TS 31.102,<br>sections 4.2.26 and 4.4.2.3, excluding the following fields:<br><br> - Alpha Identifier (currently 'FF'O * 20),<br> - Capability/Configuration1 Record Identifier ('FF'O),<br> - Extension1 Record Identifier ('FF'O).<br><br>This feature is introduced exclusively for sysmoUSIM-SJS1.<br>Othere SIM card types need to be tested.<br><br>Change-Id: Ie033a0ffc3697ae562eaa7a241a0f6af6c2b0594<br>---<br>M pySim-prog.py<br>M pySim/cards.py<br>M pySim/utils.py<br>M pysim-testdata/sysmoUSIM-SJS1.data<br>M pysim-testdata/sysmoUSIM-SJS1.ok<br>M tests/pysim-test.sh<br>M tests/sysmoUSIM-SJS1.data.example<br>7 files changed, 57 insertions(+), 3 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/pySim-prog.py b/pySim-prog.py</span><br><span>index 09a5d70..a7081ff 100755</span><br><span>--- a/pySim-prog.py</span><br><span>+++ b/pySim-prog.py</span><br><span>@@ -119,6 +119,9 @@</span><br><span> parser.add_option("-i", "--imsi", dest="imsi",</span><br><span> help="International Mobile Subscriber Identity",</span><br><span> )</span><br><span style="color: hsl(120, 100%, 40%);">+ parser.add_option("--msisdn", dest="msisdn",</span><br><span style="color: hsl(120, 100%, 40%);">+ help="Mobile Subscriber Integrated Services Digital Number",</span><br><span style="color: hsl(120, 100%, 40%);">+ )</span><br><span> parser.add_option("-k", "--ki", dest="ki",</span><br><span> help="Ki (default is to randomize)",</span><br><span> )</span><br><span>@@ -165,7 +168,6 @@</span><br><span> parser.add_option("--dry-run", dest="dry_run",</span><br><span> help="Perform a 'dry run', don't actually program the card",</span><br><span> default=False, action="store_true")</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> parser.add_option("--card_handler", dest="card_handler", metavar="FILE",</span><br><span> help="Use automatic card handling machine")</span><br><span> </span><br><span>@@ -278,6 +280,17 @@</span><br><span> if len(opts.name) > 16:</span><br><span> raise ValueError('Service Provider Name must max 16 characters!');</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if opts.msisdn is not None:</span><br><span style="color: hsl(120, 100%, 40%);">+ msisdn = opts.msisdn</span><br><span style="color: hsl(120, 100%, 40%);">+ if msisdn[0] == '+':</span><br><span style="color: hsl(120, 100%, 40%);">+ msisdn = msisdn[1:]</span><br><span style="color: hsl(120, 100%, 40%);">+ if not msisdn.isdigit():</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError('MSISDN must be digits only! '</span><br><span style="color: hsl(120, 100%, 40%);">+ 'Start with \'+\' for international numbers.')</span><br><span style="color: hsl(120, 100%, 40%);">+ if len(msisdn) > 10 * 2:</span><br><span style="color: hsl(120, 100%, 40%);">+ # TODO: Support MSISDN of length > 20 (10 Bytes)</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError('MSISDNs longer than 20 digits are not (yet) supported.')</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> # ICCID (19 digits, E.118), though some phase1 vendors use 20 :(</span><br><span> if opts.iccid is not None:</span><br><span> iccid = opts.iccid</span><br><span>@@ -426,6 +439,7 @@</span><br><span> 'opc' : opc,</span><br><span> 'acc' : acc,</span><br><span> 'pin_adm' : pin_adm,</span><br><span style="color: hsl(120, 100%, 40%);">+ 'msisdn' : opts.msisdn,</span><br><span> }</span><br><span> </span><br><span> </span><br><span>diff --git a/pySim/cards.py b/pySim/cards.py</span><br><span>index 802ad69..b4b5fdf 100644</span><br><span>--- a/pySim/cards.py</span><br><span>+++ b/pySim/cards.py</span><br><span>@@ -658,6 +658,17 @@</span><br><span> r = self._scc.select_file(['3f00', '7f10'])</span><br><span> data, sw = self._scc.update_record('6f42', 1, lpad(p['smsp'], 104), force_len=True)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ # EF.MSISDN</span><br><span style="color: hsl(120, 100%, 40%);">+ # TODO: Alpha Identifier (currently 'ff'O * 20)</span><br><span style="color: hsl(120, 100%, 40%);">+ # TODO: Capability/Configuration1 Record Identifier</span><br><span style="color: hsl(120, 100%, 40%);">+ # TODO: Extension1 Record Identifier</span><br><span style="color: hsl(120, 100%, 40%);">+ if p.get('msisdn') is not None:</span><br><span style="color: hsl(120, 100%, 40%);">+ msisdn = enc_msisdn(p['msisdn'])</span><br><span style="color: hsl(120, 100%, 40%);">+ data = 'ff' * 20 + msisdn + 'ff' * 2</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ r = self._scc.select_file(['3f00', '7f10'])</span><br><span style="color: hsl(120, 100%, 40%);">+ data, sw = self._scc.update_record('6F40', 1, data, force_len=True)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> def erase(self):</span><br><span> return</span><br><span> </span><br><span>diff --git a/pySim/utils.py b/pySim/utils.py</span><br><span>index 12f66b9..8420b23 100644</span><br><span>--- a/pySim/utils.py</span><br><span>+++ b/pySim/utils.py</span><br><span>@@ -299,3 +299,29 @@</span><br><span> msisdn = '+' + msisdn</span><br><span> </span><br><span> return (npi, ton, msisdn)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def enc_msisdn(msisdn, npi=0x01, ton=0x03):</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ Encode MSISDN as LHV so it can be stored to EF.MSISDN.</span><br><span style="color: hsl(120, 100%, 40%);">+ See 3GPP TS 31.102, section 4.2.26 and 4.4.2.3.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ Default NPI / ToN values:</span><br><span style="color: hsl(120, 100%, 40%);">+ - NPI: ISDN / telephony numbering plan (E.164 / E.163),</span><br><span style="color: hsl(120, 100%, 40%);">+ - ToN: network specific or international number (if starts with '+').</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%);">+ # Leading '+' indicates International Number</span><br><span style="color: hsl(120, 100%, 40%);">+ if msisdn[0] == '+':</span><br><span style="color: hsl(120, 100%, 40%);">+ msisdn = msisdn[1:]</span><br><span style="color: hsl(120, 100%, 40%);">+ ton = 0x01</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Append 'f' padding if number of digits is odd</span><br><span style="color: hsl(120, 100%, 40%);">+ if len(msisdn) % 2 > 0:</span><br><span style="color: hsl(120, 100%, 40%);">+ msisdn += 'f'</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # BCD length also includes NPI/ToN header</span><br><span style="color: hsl(120, 100%, 40%);">+ bcd_len = len(msisdn) // 2 + 1</span><br><span style="color: hsl(120, 100%, 40%);">+ npi_ton = (npi & 0x0f) | ((ton & 0x07) << 4) | 0x80</span><br><span style="color: hsl(120, 100%, 40%);">+ bcd = rpad(swap_nibbles(msisdn), 10 * 2) # pad to 10 octets</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return ('%02x' % bcd_len) + ('%02x' % npi_ton) + bcd</span><br><span>diff --git a/pysim-testdata/sysmoUSIM-SJS1.data b/pysim-testdata/sysmoUSIM-SJS1.data</span><br><span>index b7c1e81..c23f9f1 100644</span><br><span>--- a/pysim-testdata/sysmoUSIM-SJS1.data</span><br><span>+++ b/pysim-testdata/sysmoUSIM-SJS1.data</span><br><span>@@ -4,4 +4,5 @@</span><br><span> KI=FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</span><br><span> OPC=FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</span><br><span> IMSI=001010000000102</span><br><span style="color: hsl(120, 100%, 40%);">+MSISDN=+77776336143</span><br><span> ADM=55538407</span><br><span>diff --git a/pysim-testdata/sysmoUSIM-SJS1.ok b/pysim-testdata/sysmoUSIM-SJS1.ok</span><br><span>index 6d85f38..290c470 100644</span><br><span>--- a/pysim-testdata/sysmoUSIM-SJS1.ok</span><br><span>+++ b/pysim-testdata/sysmoUSIM-SJS1.ok</span><br><span>@@ -50,7 +50,7 @@</span><br><span> ffffff0000 # unused</span><br><span> </span><br><span> ACC: 0008</span><br><span style="color: hsl(0, 100%, 40%);">-MSISDN: Can't read file -- Length of MSISDN (136 bytes) is out of range</span><br><span style="color: hsl(120, 100%, 40%);">+MSISDN (NPI=1 ToN=1): +77776336143</span><br><span> AD: 00000002</span><br><span> Done !</span><br><span> </span><br><span>diff --git a/tests/pysim-test.sh b/tests/pysim-test.sh</span><br><span>index 0d469c9..a22c372 100755</span><br><span>--- a/tests/pysim-test.sh</span><br><span>+++ b/tests/pysim-test.sh</span><br><span>@@ -162,6 +162,7 @@</span><br><span> KI=FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</span><br><span> OPC=FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</span><br><span> IMSI=001010000000001</span><br><span style="color: hsl(120, 100%, 40%);">+ MSISDN=6766266</span><br><span> ADM=00000000</span><br><span> ADM_HEX=""</span><br><span> ADM_OPT="-a"</span><br><span>@@ -171,7 +172,7 @@</span><br><span> ADM_OPT="-A"</span><br><span> ADM=$ADM_HEX</span><br><span> fi</span><br><span style="color: hsl(0, 100%, 40%);">- python $PYSIM_PROG -p $I -t $CARD_NAME -o $OPC -k $KI -x $MCC -y $MNC -i $IMSI -s $ICCID $ADM_OPT $ADM</span><br><span style="color: hsl(120, 100%, 40%);">+ python $PYSIM_PROG -p $I -t $CARD_NAME -o $OPC -k $KI -x $MCC -y $MNC -i $IMSI -s $ICCID --msisdn $MSISDN $ADM_OPT $ADM</span><br><span> check_card $I $CARD_NAME</span><br><span> echo ""</span><br><span> done</span><br><span>diff --git a/tests/sysmoUSIM-SJS1.data.example b/tests/sysmoUSIM-SJS1.data.example</span><br><span>index d711dcb..19efd15 100644</span><br><span>--- a/tests/sysmoUSIM-SJS1.data.example</span><br><span>+++ b/tests/sysmoUSIM-SJS1.data.example</span><br><span>@@ -4,4 +4,5 @@</span><br><span> KI=FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</span><br><span> OPC=FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</span><br><span> IMSI=001010000000102</span><br><span style="color: hsl(120, 100%, 40%);">+MSISDN=+77776336143</span><br><span> ADM=12345678</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/16946">change 16946</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/+/16946"/><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: Ie033a0ffc3697ae562eaa7a241a0f6af6c2b0594 </div>
<div style="display:none"> Gerrit-Change-Number: 16946 </div>
<div style="display:none"> Gerrit-PatchSet: 11 </div>
<div style="display:none"> Gerrit-Owner: herlesupreeth <herlesupreeth@gmail.com> </div>
<div style="display:none"> Gerrit-Assignee: dexter <pmaier@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: fixeria <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-CC: dexter <pmaier@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>