<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/23705">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">integrate 'construct' python library<br><br>'construct' is a declarative symmetric encoder/decoder for user<br>specified binary formats. It should come in extremely handy in<br>tools like pySim.<br><br>We start the integration by adding transport methods for transceiving<br>APDUs with built-in encoding of the command data and decoding of the<br>response data.<br><br>Change-Id: Ibf457aa8b9480a8db5979defcfafd67674303f6c<br>---<br>M docs/library.rst<br>A pySim/construct.py<br>M pySim/transport/__init__.py<br>M requirements.txt<br>M setup.py<br>5 files changed, 102 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/05/23705/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/docs/library.rst b/docs/library.rst</span><br><span>index 656a780..e2e24a7 100644</span><br><span>--- a/docs/library.rst</span><br><span>+++ b/docs/library.rst</span><br><span>@@ -73,6 +73,14 @@</span><br><span> .. automodule:: pySim.transport.serial</span><br><span> :members:</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+pySim construct utilities</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%);">+.. automodule:: pySim.construct</span><br><span style="color: hsl(120, 100%, 40%);">+ :members:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> pySim utility functions</span><br><span> -----------------------</span><br><span> </span><br><span>diff --git a/pySim/construct.py b/pySim/construct.py</span><br><span>new file mode 100644</span><br><span>index 0000000..03d284e</span><br><span>--- /dev/null</span><br><span>+++ b/pySim/construct.py</span><br><span>@@ -0,0 +1,42 @@</span><br><span style="color: hsl(120, 100%, 40%);">+from construct import *</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.utils import b2h, h2b</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+"""Utility code related to the integration of the 'construct' declarative parser."""</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# (C) 2021 by Harald Welte <laforge@osmocom.org></span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is free software: you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+# it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+# the Free Software Foundation, either version 2 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+# (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+# but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+# GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+# along with this program. If not, see <http://www.gnu.org/licenses/>.</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%);">+class HexAdapter(Adapter):</span><br><span style="color: hsl(120, 100%, 40%);">+ """convert a bytes() type to a string of hex nibbles."""</span><br><span style="color: hsl(120, 100%, 40%);">+ def _decode(self, obj, context, path):</span><br><span style="color: hsl(120, 100%, 40%);">+ return b2h(obj)</span><br><span style="color: hsl(120, 100%, 40%);">+ def _encode(self, obj, context, path):</span><br><span style="color: hsl(120, 100%, 40%);">+ return h2b(obj)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+def filter_dict(d, exclude_prefix='_'):</span><br><span style="color: hsl(120, 100%, 40%);">+ """filter the input dict to ensure no keys starting with 'exclude_prefix' remain."""</span><br><span style="color: hsl(120, 100%, 40%);">+ res = {}</span><br><span style="color: hsl(120, 100%, 40%);">+ for (key, value) in d.items():</span><br><span style="color: hsl(120, 100%, 40%);">+ if key.startswith(exclude_prefix):</span><br><span style="color: hsl(120, 100%, 40%);">+ continue</span><br><span style="color: hsl(120, 100%, 40%);">+ if type(value) is dict:</span><br><span style="color: hsl(120, 100%, 40%);">+ res[key] = filter_dict(value)</span><br><span style="color: hsl(120, 100%, 40%);">+ else:</span><br><span style="color: hsl(120, 100%, 40%);">+ res[key] = value</span><br><span style="color: hsl(120, 100%, 40%);">+ return res</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# here we collect some shared / common definitions of data types</span><br><span style="color: hsl(120, 100%, 40%);">+LV = Prefixed(Int8ub, HexAdapter(GreedyBytes))</span><br><span>diff --git a/pySim/transport/__init__.py b/pySim/transport/__init__.py</span><br><span>index 96ad974..290bc7c 100644</span><br><span>--- a/pySim/transport/__init__.py</span><br><span>+++ b/pySim/transport/__init__.py</span><br><span>@@ -6,10 +6,12 @@</span><br><span> from typing import Optional</span><br><span> </span><br><span> from pySim.exceptions import *</span><br><span style="color: hsl(0, 100%, 40%);">-from pySim.utils import sw_match</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.construct import filter_dict</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.utils import sw_match, b2h, h2b, i2h</span><br><span> </span><br><span> #</span><br><span> # Copyright (C) 2009-2010 Sylvain Munaut <tnt@246tNt.com></span><br><span style="color: hsl(120, 100%, 40%);">+# Copyright (C) 2021 Harald Welte <laforge@osmocom.org></span><br><span> #</span><br><span> # This program is free software: you can redistribute it and/or modify</span><br><span> # it under the terms of the GNU General Public License as published by</span><br><span>@@ -127,6 +129,52 @@</span><br><span> raise SwMatchError(rv[1], sw.lower(), self.sw_interpreter)</span><br><span> return rv</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ def send_apdu_constr(self, cla, ins, p1, p2, cmd_constr, cmd_data, resp_constr):</span><br><span style="color: hsl(120, 100%, 40%);">+ """Build and sends an APDU using a 'construct' definition; parses response.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ Args:</span><br><span style="color: hsl(120, 100%, 40%);">+ cla : string (in hex) ISO 7816 class byte</span><br><span style="color: hsl(120, 100%, 40%);">+ ins : string (in hex) ISO 7816 instruction byte</span><br><span style="color: hsl(120, 100%, 40%);">+ p1 : string (in hex) ISO 7116 Parameter 1 byte</span><br><span style="color: hsl(120, 100%, 40%);">+ p2 : string (in hex) ISO 7116 Parameter 2 byte</span><br><span style="color: hsl(120, 100%, 40%);">+ cmd_cosntr : defining how to generate binary APDU command data</span><br><span style="color: hsl(120, 100%, 40%);">+ cmd_data : command data passed to cmd_constr</span><br><span style="color: hsl(120, 100%, 40%);">+ resp_cosntr : defining how to decode binary APDU response data</span><br><span style="color: hsl(120, 100%, 40%);">+ Returns:</span><br><span style="color: hsl(120, 100%, 40%);">+ Tuple of (decoded_data, sw)</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ cmd = cmd_constr.build(cmd_data) if cmd_data else ''</span><br><span style="color: hsl(120, 100%, 40%);">+ p3 = i2h([len(cmd)])</span><br><span style="color: hsl(120, 100%, 40%);">+ pdu = ''.join([cla, ins, p1, p2, p3, b2h(cmd)])</span><br><span style="color: hsl(120, 100%, 40%);">+ (data, sw) = self.send_apdu(pdu)</span><br><span style="color: hsl(120, 100%, 40%);">+ if data:</span><br><span style="color: hsl(120, 100%, 40%);">+ # filter the resulting dict to avoid '_io' members inside</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = filter_dict(resp_constr.parse(h2b(data)))</span><br><span style="color: hsl(120, 100%, 40%);">+ else:</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = None</span><br><span style="color: hsl(120, 100%, 40%);">+ return (rsp, sw)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def send_apdu_constr_checksw(self, cla, ins, p1, p2, cmd_constr, cmd_data, resp_constr,</span><br><span style="color: hsl(120, 100%, 40%);">+ sw_exp="9000"):</span><br><span style="color: hsl(120, 100%, 40%);">+ """Build and sends an APDU using a 'construct' definition; parses response.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ Args:</span><br><span style="color: hsl(120, 100%, 40%);">+ cla : string (in hex) ISO 7816 class byte</span><br><span style="color: hsl(120, 100%, 40%);">+ ins : string (in hex) ISO 7816 instruction byte</span><br><span style="color: hsl(120, 100%, 40%);">+ p1 : string (in hex) ISO 7116 Parameter 1 byte</span><br><span style="color: hsl(120, 100%, 40%);">+ p2 : string (in hex) ISO 7116 Parameter 2 byte</span><br><span style="color: hsl(120, 100%, 40%);">+ cmd_cosntr : defining how to generate binary APDU command data</span><br><span style="color: hsl(120, 100%, 40%);">+ cmd_data : command data passed to cmd_constr</span><br><span style="color: hsl(120, 100%, 40%);">+ resp_cosntr : defining how to decode binary APDU response data</span><br><span style="color: hsl(120, 100%, 40%);">+ exp_sw : string (in hex) of status word (ex. "9000")</span><br><span style="color: hsl(120, 100%, 40%);">+ Returns:</span><br><span style="color: hsl(120, 100%, 40%);">+ Tuple of (decoded_data, sw)</span><br><span style="color: hsl(120, 100%, 40%);">+ """</span><br><span style="color: hsl(120, 100%, 40%);">+ (rsp, sw) = self.send_apdu_constr(cla, ins, p1, p2, cmd_constr, cmd_data, resp_constr)</span><br><span style="color: hsl(120, 100%, 40%);">+ if not sw_match(sw, sw_exp):</span><br><span style="color: hsl(120, 100%, 40%);">+ raise SwMatchError(sw, sw_exp.lower(), self.sw_interpreter)</span><br><span style="color: hsl(120, 100%, 40%);">+ return (rsp, sw)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> def init_reader(opts, **kwargs) -> Optional[LinkBase]:</span><br><span> """</span><br><span> Init card reader driver</span><br><span>diff --git a/requirements.txt b/requirements.txt</span><br><span>index f203ed1..6da27cc 100644</span><br><span>--- a/requirements.txt</span><br><span>+++ b/requirements.txt</span><br><span>@@ -3,3 +3,4 @@</span><br><span> pytlv</span><br><span> cmd2</span><br><span> jsonpath-ng</span><br><span style="color: hsl(120, 100%, 40%);">+construct</span><br><span>diff --git a/setup.py b/setup.py</span><br><span>index e7ab1c9..0fa3f1a 100644</span><br><span>--- a/setup.py</span><br><span>+++ b/setup.py</span><br><span>@@ -13,7 +13,8 @@</span><br><span> "serial",</span><br><span> "pytlv",</span><br><span> "cmd2",</span><br><span style="color: hsl(0, 100%, 40%);">- "jsonpath-ng"</span><br><span style="color: hsl(120, 100%, 40%);">+ "jsonpath-ng",</span><br><span style="color: hsl(120, 100%, 40%);">+ "construct",</span><br><span> ],</span><br><span> scripts=[</span><br><span> 'pySim-prog.py',</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/23705">change 23705</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/+/23705"/><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: Ibf457aa8b9480a8db5979defcfafd67674303f6c </div>
<div style="display:none"> Gerrit-Change-Number: 23705 </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>