December 2023 - gerrit-log - lists.osmocom.org

[M] Change in pysim[master]: data-driven TLV unit data test support

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/35441?usp=email ) Change subject: data-driven TLV unit data test support ...................................................................... data-driven TLV unit data test support While we do have the _test_de_encode data driven tests for file definitions, we don't yet have something similar for derived classes of BER_TLV_IE. This means that TLVs used outside of the filesystem context (for example, decoding the SELECT/STATUS response, but also eUICC and other stuff) do not yet have test coverage. This commit just adds the related test code, but no test data yet. Related: OS#6317 Change-Id: Ied85f292bb57fde11dc188be84e3384dc3ff1601 --- A tests/test_tlvs.py 1 file changed, 140 insertions(+), 0 deletions(-) Approvals: laforge: Looks good to me, approved Jenkins Builder: Verified diff --git a/tests/test_tlvs.py b/tests/test_tlvs.py new file mode 100755 index 0000000..b0ad48a --- /dev/null +++ b/tests/test_tlvs.py @@ -0,0 +1,122 @@ +#!/usr/bin/env python3 + +# (C) 2023 by Harald Welte <laforge(a)osmocom.org> +# +# 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 <http://www.gnu.org/licenses/>. + +import unittest +import logging + +from pySim.utils import b2h, h2b, all_subclasses +from pySim.tlv import * + +import pySim.iso7816_4 +import pySim.ts_102_221 +import pySim.ts_102_222 +import pySim.ts_31_102 +import pySim.ts_31_103 +import pySim.ts_51_011 +import pySim.sysmocom_sja2 +import pySim.gsm_r +import pySim.cdma_ruim + +if 'unittest.util' in __import__('sys').modules: + # Show full diff in self.assertEqual. + __import__('sys').modules['unittest.util']._MAX_LENGTH = 999999999 + +def get_qualified_name(c): + """return the qualified (by module) name of a class.""" + return "%s.%s" % (c.__module__, c.__name__) + +class TLV_IE_Test(unittest.TestCase): + maxDiff = None + + @classmethod + def get_classes(cls): + """get list of TLV_IE sub-classes.""" + return all_subclasses(TLV_IE) + + @classmethod + def setUpClass(cls): + """set-up method called once for this class by unittest framework""" + cls.classes = cls.get_classes() + + def test_decode_tlv(self): + """Test the decoder for a TLV_IE. Requires the given TLV_IE subclass + to have a '_test_decode' attribute, containing a list of tuples. Each tuple + is a 2-tuple (hexstring, decoded_dict). + """ + for c in self.classes: + name = get_qualified_name(c) + if hasattr(c, '_test_decode'): + for t in c._test_decode: + with self.subTest(name, test_decode=t): + inst = c() + encoded = t[0] + decoded = { camel_to_snake(c.__name__): t[1] } + context = t[2] if len(t) == 3 else {} + logging.debug("Testing decode of %s", name) + inst.from_tlv(h2b(encoded), context=context) + re_dec = inst.to_dict() + self.assertEqual(decoded, re_dec) + + def test_encode_tlv(self): + """Test the encoder for a TLV_IE. Requires the given TLV_IE subclass + to have a '_test_encode' attribute, containing a list of tuples. Each tuple + is a 2-tuple (hexstring, decoded_dict). + """ + for c in self.classes: + name = get_qualified_name(c) + if hasattr(c, '_test_encode'): + for t in c._test_encode: + with self.subTest(name, test_encode=t): + inst = c() + encoded = t[0] + decoded = { camel_to_snake(c.__name__): t[1] } + context = t[2] if len(t) == 3 else {} + logging.debug("Testing encode of %s", name) + inst.from_dict(decoded) + re_enc = b2h(inst.to_tlv(context)) + self.assertEqual(encoded.upper(), re_enc.upper()) + + def test_de_encode_tlv(self): + """Test the decoder and encoder for a TLV_IE. Performs first a decoder + test, and then re-encodes the decoded data, comparing the re-encoded data with the + initial input data. + + Requires the given TLV_IE subclass to have a '_test_de_encode' attribute, + containing a list of tuples. Each tuple is a 2-tuple (hexstring, decoded_dict). + """ + for c in self.classes: + name = get_qualified_name(c) + if hasattr(c, '_test_de_encode'): + for t in c._test_de_encode: + with self.subTest(name, test_de_encode=t): + inst = c() + encoded = t[0] + decoded = { camel_to_snake(c.__name__): t[1] } + context = t[2] if len(t) == 3 else {} + logging.debug("Testing decode of %s", name) + inst.from_tlv(h2b(encoded), context=context) + re_dec = inst.to_dict() + self.assertEqual(decoded, re_dec) + logging.debug("Testing re-encode of %s", name) + re_enc = b2h(inst.to_tlv(context=context)) + self.assertEqual(encoded.upper(), re_enc.upper()) + + +if __name__ == '__main__': + logger = logging.getLogger() + logger.setLevel(logging.DEBUG) + unittest.main() -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35441?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Ied85f292bb57fde11dc188be84e3384dc3ff1601 Gerrit-Change-Number: 35441 Gerrit-PatchSet: 3 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-MessageType: merged

1 year, 5 months

1
0
0 0

[M] Change in pysim[master]: data-driven TLV unit data test support

by laforge

Attention is currently required from: dexter. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35441?usp=email ) Change subject: data-driven TLV unit data test support ...................................................................... Patch Set 3: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35441?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Ied85f292bb57fde11dc188be84e3384dc3ff1601 Gerrit-Change-Number: 35441 Gerrit-PatchSet: 3 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Wed, 27 Dec 2023 15:27:10 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: tlv: Fix from_dict() symmetry

by laforge

laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35447?usp=email ) Change subject: tlv: Fix from_dict() symmetry ...................................................................... Patch Set 2: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35447?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I07e4feb3800b420d8be7aae8911f828f1da9dab8 Gerrit-Change-Number: 35447 Gerrit-PatchSet: 2 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Comment-Date: Wed, 27 Dec 2023 15:27:01 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: filesystem: use pySim.utils.build_construct()

by fixeria

fixeria has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35439?usp=email ) Change subject: filesystem: use pySim.utils.build_construct() ...................................................................... Patch Set 2: Code-Review+1 -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35439?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Ibfd61cd87edc72882aa66d6ff17861a3e918affb Gerrit-Change-Number: 35439 Gerrit-PatchSet: 2 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Comment-Date: Wed, 27 Dec 2023 15:13:02 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: Fix enumeration of GlobbalPlatformISDR during card_init()

by laforge

Attention is currently required from: dexter, fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35440?usp=email ) Change subject: Fix enumeration of GlobbalPlatformISDR during card_init() ...................................................................... Patch Set 1: (1 comment) File pySim/global_platform.py: https://gerrit.osmocom.org/c/pysim/+/35440/comment/64b31f36_d293ac57 PS1, Line 262: intermediate = False it's rather ugly that we have to explicitly set this to False in the "leaf" class[es]. Ideally we'd have some kind of attribute that is not inheritable. Something that only exists in CardApplicationSD but not any derived classes. -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35440?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I7fb1637f8f7a149b536c4d77dac92736c526aa6c Gerrit-Change-Number: 35440 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Wed, 27 Dec 2023 15:12:14 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Gerrit-MessageType: comment

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: filesystem: use pySim.utils.build_construct()

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/35439?usp=email ) Change subject: filesystem: use pySim.utils.build_construct() ...................................................................... filesystem: use pySim.utils.build_construct() We recently introduced a pySim.utils.build_construct() wrapper around the raw call of the construct.build() method. So far, this wrapper was only used from pySim.tlv, but let's also use it from pySim.filesystem. Basically, whenever we use parse_construct(), we should use build_construct() as the inverse operation. Change-Id: Ibfd61cd87edc72882aa66d6ff17861a3e918affb --- M pySim/filesystem.py M pySim/sysmocom_sja2.py 2 files changed, 26 insertions(+), 9 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved diff --git a/pySim/filesystem.py b/pySim/filesystem.py index 0e72921..438e969 100644 --- a/pySim/filesystem.py +++ b/pySim/filesystem.py @@ -39,7 +39,7 @@ from smartcard.util import toBytes from pySim.utils import sw_match, h2b, b2h, i2h, is_hex, auto_int, bertlv_parse_one, Hexstr -from pySim.construct import filter_dict, parse_construct +from pySim.construct import filter_dict, parse_construct, build_construct from pySim.exceptions import * from pySim.jsonpath import js_path_find, js_path_modify from pySim.commands import SimCardCommands @@ -749,7 +749,7 @@ if callable(method): return h2b(method(abstract_data)) if self._construct: - return self._construct.build(abstract_data) + return build_construct(self._construct, abstract_data) elif self._tlv: t = self._tlv() if inspect.isclass(self._tlv) else self._tlv t.from_dict(abstract_data) @@ -777,7 +777,7 @@ raw_bin_data = method(abstract_data) return b2h(raw_bin_data) if self._construct: - return b2h(self._construct.build(abstract_data)) + return b2h(build_construct(self._construct, abstract_data)) elif self._tlv: t = self._tlv() if inspect.isclass(self._tlv) else self._tlv t.from_dict(abstract_data) @@ -1025,7 +1025,7 @@ raw_bin_data = method(abstract_data, record_nr=record_nr) return b2h(raw_bin_data) if self._construct: - return b2h(self._construct.build(abstract_data)) + return b2h(build_construct(self._construct, abstract_data)) elif self._tlv: t = self._tlv() if inspect.isclass(self._tlv) else self._tlv t.from_dict(abstract_data) @@ -1053,7 +1053,7 @@ if callable(method): return h2b(method(abstract_data, record_nr=record_nr)) if self._construct: - return self._construct.build(abstract_data) + return build_construct(self._construct, abstract_data) elif self._tlv: t = self._tlv() if inspect.isclass(self._tlv) else self._tlv t.from_dict(abstract_data) @@ -1169,7 +1169,7 @@ if callable(method): return b2h(method(abstract_data)) if self._construct: - return b2h(filter_dict(self._construct.build(abstract_data))) + return b2h(filter_dict(build_construct(self._construct, abstract_data))) elif self._tlv: t = self._tlv() if inspect.isclass(self._tlv) else self._tlv t.from_dict(abstract_data) @@ -1196,7 +1196,7 @@ if callable(method): return h2b(method(abstract_data)) if self._construct: - return filter_dict(self._construct.build(abstract_data)) + return filter_dict(build_construct(self._construct, abstract_data)) elif self._tlv: t = self._tlv() if inspect.isclass(self._tlv) else self._tlv t.from_dict(abstract_data) diff --git a/pySim/sysmocom_sja2.py b/pySim/sysmocom_sja2.py index 8d3750c..a25bece 100644 --- a/pySim/sysmocom_sja2.py +++ b/pySim/sysmocom_sja2.py @@ -237,9 +237,9 @@ def _encode_bin(self, abstract_data: dict) -> bytearray: if abstract_data['cfg']['algorithm'] == 'tuak': - return self._constr_tuak.build(abstract_data) + return build_construct(self._constr_tuak, abstract_data) else: - return self._construct.build(abstract_data) + return build_construct(self._construct, abstract_data) class EF_USIM_AUTH_KEY_2G(TransparentEF): -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35439?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Ibfd61cd87edc72882aa66d6ff17861a3e918affb Gerrit-Change-Number: 35439 Gerrit-PatchSet: 2 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-MessageType: merged

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: filesystem: use pySim.utils.build_construct()

by laforge

Attention is currently required from: dexter. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35439?usp=email ) Change subject: filesystem: use pySim.utils.build_construct() ...................................................................... Patch Set 2: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35439?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Ibfd61cd87edc72882aa66d6ff17861a3e918affb Gerrit-Change-Number: 35439 Gerrit-PatchSet: 2 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Wed, 27 Dec 2023 15:10:55 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: Fix enumeration of GlobbalPlatformISDR during card_init()

by laforge

Attention is currently required from: dexter, fixeria. laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35440?usp=email ) Change subject: Fix enumeration of GlobbalPlatformISDR during card_init() ...................................................................... Patch Set 1: (1 comment) Patchset: PS1: not sure if there's a more elegant way to resolve this other than the manual/explicit 'intermediate' class atrribute -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35440?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I7fb1637f8f7a149b536c4d77dac92736c526aa6c Gerrit-Change-Number: 35440 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: dexter <pmaier(a)sysmocom.de> Gerrit-Comment-Date: Wed, 27 Dec 2023 15:09:52 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Gerrit-MessageType: comment

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: tlv: Fix from_dict() symmetry

by laforge

laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/pysim/+/35447?usp=email ) Change subject: tlv: Fix from_dict() symmetry ...................................................................... tlv: Fix from_dict() symmetry the to_dict() method generates a {class_name: value} dictionary, for both the nested and non-nested case. However, before this patch, the from_dict() method expects a plain list of child IE dicts in the nested case. This is illogical. Let's make sure from_dict always expectes a {class_name: value} dict for both nested and non-nested situations. Change-Id: I07e4feb3800b420d8be7aae8911f828f1da9dab8 --- M pySim/tlv.py 1 file changed, 21 insertions(+), 4 deletions(-) git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/47/35447/1 diff --git a/pySim/tlv.py b/pySim/tlv.py index 6ea7dd1..4ac5ebf 100644 --- a/pySim/tlv.py +++ b/pySim/tlv.py @@ -157,13 +157,13 @@ def from_dict(self, decoded: dict): """Set the IE internal decoded representation to data from the argument. If this is a nested IE, the child IE instance list is re-created.""" + expected_key_name = camel_to_snake(type(self).__name__) + if not expected_key_name in decoded: + raise ValueError("Dict %s doesn't contain expected key %s" % (decoded, expected_key_name)) if self.nested_collection: - self.children = self.nested_collection.from_dict(decoded) + self.children = self.nested_collection.from_dict(decoded[expected_key_name]) else: self.children = [] - expected_key_name = camel_to_snake(type(self).__name__) - if not expected_key_name in decoded: - raise ValueError("Dict %s doesn't contain expected key %s" % (decoded, expected_key_name)) self.decoded = decoded[expected_key_name] def is_constructed(self): -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35447?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I07e4feb3800b420d8be7aae8911f828f1da9dab8 Gerrit-Change-Number: 35447 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-MessageType: newchange

1 year, 5 months

1
0
0 0

[S] Change in pysim[master]: global_platform: Correctly decode Key Information Data

by laforge

laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/pysim/+/35448?usp=email ) Change subject: global_platform: Correctly decode Key Information Data ...................................................................... global_platform: Correctly decode Key Information Data The list contains tuples of (key_type, key_length). Let's fix that. Change-Id: Icf367827d62ed67afa27ee3d0ba9d5cd5bc65c99 --- M pySim/global_platform.py 1 file changed, 13 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/48/35448/1 diff --git a/pySim/global_platform.py b/pySim/global_platform.py index 5382f93..8558697 100644 --- a/pySim/global_platform.py +++ b/pySim/global_platform.py @@ -95,8 +95,9 @@ # c0 04 02038010 # c0 04 03038010 class KeyInformationData(BER_TLV_IE, tag=0xc0): + KeyTypeLen = Struct('type'/KeyType, 'length'/Int8ub) _construct = Struct('key_identifier'/Byte, 'key_version_number'/Byte, - 'key_types'/GreedyRange(KeyType)) + 'key_types'/GreedyRange(KeyTypeLen)) class KeyInformation(BER_TLV_IE, tag=0xe0, nested=[KeyInformationData]): pass -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35448?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Icf367827d62ed67afa27ee3d0ba9d5cd5bc65c99 Gerrit-Change-Number: 35448 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-MessageType: newchange

1 year, 5 months

1
0
0 0

2025

2024

2023

2022

gerrit-log December 2023