diff --git a/contrib/jenkins.sh b/contrib/jenkins.sh index f83e6a53..dc2692c3 100755 --- a/contrib/jenkins.sh +++ b/contrib/jenkins.sh @@ -15,6 +15,7 @@ pip install pytlv pip install pyyaml pip install cmd2 pip install jsonpath-ng +pip install construct # Execute automatically discovered unit tests first python -m unittest discover -v -s tests/ diff --git a/docs/library.rst b/docs/library.rst index 656a7802..e2e24a73 100644 --- a/docs/library.rst +++ b/docs/library.rst @@ -73,6 +73,14 @@ at 9600 bps. These readers are sometimes called `Phoenix`. .. automodule:: pySim.transport.serial :members: + +pySim construct utilities +------------------------- + +.. automodule:: pySim.construct + :members: + + pySim utility functions ----------------------- diff --git a/pySim/construct.py b/pySim/construct.py new file mode 100644 index 00000000..03d284e4 --- /dev/null +++ b/pySim/construct.py @@ -0,0 +1,42 @@ +from construct import * +from pySim.utils import b2h, h2b + +"""Utility code related to the integration of the 'construct' declarative parser.""" + +# (C) 2021 by Harald Welte +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +class HexAdapter(Adapter): + """convert a bytes() type to a string of hex nibbles.""" + def _decode(self, obj, context, path): + return b2h(obj) + def _encode(self, obj, context, path): + return h2b(obj) + +def filter_dict(d, exclude_prefix='_'): + """filter the input dict to ensure no keys starting with 'exclude_prefix' remain.""" + res = {} + for (key, value) in d.items(): + if key.startswith(exclude_prefix): + continue + if type(value) is dict: + res[key] = filter_dict(value) + else: + res[key] = value + return res + +# here we collect some shared / common definitions of data types +LV = Prefixed(Int8ub, HexAdapter(GreedyBytes)) diff --git a/pySim/transport/__init__.py b/pySim/transport/__init__.py index 96ad9742..290bc7cf 100644 --- a/pySim/transport/__init__.py +++ b/pySim/transport/__init__.py @@ -6,10 +6,12 @@ from typing import Optional from pySim.exceptions import * -from pySim.utils import sw_match +from pySim.construct import filter_dict +from pySim.utils import sw_match, b2h, h2b, i2h # # Copyright (C) 2009-2010 Sylvain Munaut +# Copyright (C) 2021 Harald Welte # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -127,6 +129,52 @@ class LinkBase(object): raise SwMatchError(rv[1], sw.lower(), self.sw_interpreter) return rv + def send_apdu_constr(self, cla, ins, p1, p2, cmd_constr, cmd_data, resp_constr): + """Build and sends an APDU using a 'construct' definition; parses response. + + Args: + cla : string (in hex) ISO 7816 class byte + ins : string (in hex) ISO 7816 instruction byte + p1 : string (in hex) ISO 7116 Parameter 1 byte + p2 : string (in hex) ISO 7116 Parameter 2 byte + cmd_cosntr : defining how to generate binary APDU command data + cmd_data : command data passed to cmd_constr + resp_cosntr : defining how to decode binary APDU response data + Returns: + Tuple of (decoded_data, sw) + """ + cmd = cmd_constr.build(cmd_data) if cmd_data else '' + p3 = i2h([len(cmd)]) + pdu = ''.join([cla, ins, p1, p2, p3, b2h(cmd)]) + (data, sw) = self.send_apdu(pdu) + if data: + # filter the resulting dict to avoid '_io' members inside + rsp = filter_dict(resp_constr.parse(h2b(data))) + else: + rsp = None + return (rsp, sw) + + def send_apdu_constr_checksw(self, cla, ins, p1, p2, cmd_constr, cmd_data, resp_constr, + sw_exp="9000"): + """Build and sends an APDU using a 'construct' definition; parses response. + + Args: + cla : string (in hex) ISO 7816 class byte + ins : string (in hex) ISO 7816 instruction byte + p1 : string (in hex) ISO 7116 Parameter 1 byte + p2 : string (in hex) ISO 7116 Parameter 2 byte + cmd_cosntr : defining how to generate binary APDU command data + cmd_data : command data passed to cmd_constr + resp_cosntr : defining how to decode binary APDU response data + exp_sw : string (in hex) of status word (ex. "9000") + Returns: + Tuple of (decoded_data, sw) + """ + (rsp, sw) = self.send_apdu_constr(cla, ins, p1, p2, cmd_constr, cmd_data, resp_constr) + if not sw_match(sw, sw_exp): + raise SwMatchError(sw, sw_exp.lower(), self.sw_interpreter) + return (rsp, sw) + def init_reader(opts, **kwargs) -> Optional[LinkBase]: """ Init card reader driver diff --git a/requirements.txt b/requirements.txt index f203ed18..6da27cc3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,4 @@ serial pytlv cmd2 jsonpath-ng +construct diff --git a/setup.py b/setup.py index e7ab1c9a..0fa3f1a6 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,8 @@ setup( "serial", "pytlv", "cmd2", - "jsonpath-ng" + "jsonpath-ng", + "construct", ], scripts=[ 'pySim-prog.py',